Graphiant Portal REST API

{
  "openapi": "3.0.0",
  "info": {
    "title": "Graphiant APIs",
    "version": "1.0.0",
    "description": "Graphiant API documentation."
  },
  "servers": [
    {
      "url": "https://api.graphiant.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "jwtAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "authorization",
        "description": "Use `Bearer <token>`"
      }
    },
    "schemas": {
      "v2ParentalertlistPostRequest": {
        "type": "object",
        "properties": {
          "timeWindow": {
            "$ref": "#/components/schemas/alertserviceTimeWindow"
          }
        },
        "additionalProperties": false
      },
      "alertserviceTimeWindow": {
        "type": "object",
        "properties": {
          "bucketSizeSec": {
            "type": "integer",
            "format": "int32",
            "example": 123,
            "minimum": 0
          },
          "oldTs": {
            "$ref": "#/components/schemas/googleProtobufTimestamp"
          },
          "recentTs": {
            "$ref": "#/components/schemas/googleProtobufTimestamp"
          }
        },
        "additionalProperties": false
      },
      "googleProtobufTimestamp": {
        "type": "object",
        "properties": {
          "nanos": {
            "type": "integer",
            "format": "int32",
            "example": 123
          },
          "seconds": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011
          }
        },
        "additionalProperties": false
      },
      "v2ParentalertlistPostResponse": {
        "type": "object",
        "properties": {
          "alertList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAlertRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "alertserviceAlertRecord": {
        "type": "object",
        "properties": {
          "acknowledgedList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of users that have acknowledged the alert"
            }
          },
          "acknowledgementReason": {
            "type": "string",
            "example": "example string",
            "description": "Reason put by users when acknowledged"
          },
          "alertBody": {
            "type": "string",
            "example": "example string",
            "description": "Latest event(s) behind the alert (required)"
          },
          "alertId": {
            "type": "string",
            "example": "example string",
            "description": "Unique id of the alert (required)"
          },
          "allowListed": {
            "type": "boolean",
            "example": true,
            "description": "whether entity in alert is put in allowlist/excludelist, disabling alert (required)"
          },
          "childrenAlertList": {
            "$ref": "#/components/schemas/alertserviceChildrenAlertListResponse"
          },
          "descendantPresent": {
            "type": "boolean",
            "example": true,
            "description": "Whether or not descendants are present (required)"
          },
          "deviceId": {
            "type": "string",
            "example": "example string",
            "description": "Internal device id to navigate to troubleshooting"
          },
          "endTime": {
            "type": "integer",
            "format": "int64",
            "example": 12345678910,
            "minimum": 0,
            "description": "When this alert was last seen as a continuation (required)"
          },
          "enterpriseId": {
            "type": "string",
            "example": "example string",
            "description": "Internal enterprise id to navigate to troubleshooting (required)"
          },
          "entity": {
            "type": "string",
            "example": "example string",
            "description": "Entity that triggered the alert. Edge, core, etc. (required)"
          },
          "interfaceName": {
            "type": "string",
            "example": "example string",
            "description": "Device Interface Name"
          },
          "muteListed": {
            "type": "boolean",
            "example": true,
            "description": "whether entity in alert is put in notification mutelist (required)"
          },
          "notificationCreated": {
            "type": "boolean",
            "example": true,
            "description": "whether notification exists for this rule (required)"
          },
          "occurrences": {
            "type": "integer",
            "format": "int64",
            "example": 12345678910,
            "minimum": 0,
            "description": "Number of times alert was raised as a continuation (required)"
          },
          "peerDeviceId": {
            "type": "string",
            "example": "example string",
            "description": "peer device id"
          },
          "peerInterfaceName": {
            "type": "string",
            "example": "example string",
            "description": "Peer Interface Name"
          },
          "peerName": {
            "type": "string",
            "example": "example string",
            "description": "Peer Name"
          },
          "plane": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Plane of the rule generating the alert (required)"
          },
          "reason": {
            "type": "string",
            "example": "example string",
            "description": "Reason why alert was generated (required)"
          },
          "recommendation": {
            "type": "string",
            "example": "example string",
            "description": "Recommendation to recover from alert (required)"
          },
          "ruleId": {
            "type": "string",
            "example": "example string",
            "description": "Unique id of the rule generating the alert (required)"
          },
          "severity": {
            "type": "string",
            "example": "Low",
            "description": "Severity of the rule behind the alert (required)"
          },
          "siteId": {
            "type": "string",
            "example": "example string",
            "description": "Internal site id to navigate to troubleshooting"
          },
          "startTime": {
            "type": "integer",
            "format": "int64",
            "example": 12345678910,
            "minimum": 0,
            "description": "When this alert was first triggered (required)"
          },
          "status": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Status of the alert whether active or inactive (required)"
          },
          "troubleshootingDisabledReason": {
            "type": "string",
            "example": "example string",
            "description": "Reason to not navigate to troubleshooting"
          },
          "troubleshootingEnabled": {
            "type": "boolean",
            "example": true,
            "description": "Navigate or not navigate to troubleshooting dashboard (required)"
          },
          "tunnelInterfaceName": {
            "type": "string",
            "example": "example string",
            "description": "Tunnel Interface Name"
          },
          "type": {
            "type": "string",
            "example": "example string",
            "description": "Type of alert (required)"
          }
        },
        "additionalProperties": false
      },
      "alertserviceChildrenAlertListResponse": {
        "type": "object",
        "properties": {
          "alertList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAlertRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "v2ChildalertlistPostRequest": {
        "type": "object",
        "properties": {
          "alertId": {
            "type": "string",
            "example": "example string",
            "description": "Alert id of the parent alert (required)"
          }
        },
        "additionalProperties": false,
        "required": [
          "alertId"
        ]
      },
      "v2ChildalertlistPostResponse": {
        "type": "object",
        "properties": {
          "alertList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAlertRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "v2NotificationlistPostRequest": {
        "type": "object",
        "properties": {
          "timeWindow": {
            "$ref": "#/components/schemas/alertserviceTimeWindow"
          }
        },
        "additionalProperties": false
      },
      "v2NotificationlistPostResponse": {
        "type": "object",
        "properties": {
          "notificationList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceNotificationRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "alertserviceNotificationRecord": {
        "type": "object",
        "properties": {
          "alertType": {
            "type": "string",
            "example": "example string",
            "description": "Type of the alert underlying the notification (required)"
          },
          "muteCount": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011,
            "description": "Number of entities notificated muted (required)"
          },
          "name": {
            "type": "string",
            "example": "example string",
            "description": "Name given to the notification record (required)"
          },
          "notificationBody": {
            "$ref": "#/components/schemas/alertserviceNotificationBody"
          },
          "notificationId": {
            "type": "string",
            "example": "example string",
            "description": "Unique id for the notification record (required)"
          },
          "ruleId": {
            "type": "string",
            "example": "example string",
            "description": "The id of the rule on which notification is created (required)"
          },
          "timesTriggered": {
            "type": "integer",
            "format": "int64",
            "example": 12345678910,
            "minimum": 0,
            "description": "Number of times notification was triggered for the same alert (required)"
          }
        },
        "additionalProperties": false
      },
      "alertserviceNotificationBody": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "example": "example string",
            "description": "Description of notification"
          },
          "duration": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Time interval for notification (required)"
          },
          "enabled": {
            "type": "boolean",
            "example": true,
            "description": "Enable or disable notification (required)"
          },
          "frequency": {
            "type": "integer",
            "format": "int64",
            "example": 12345678910,
            "minimum": 0,
            "description": "Frequency of notifying a continuing alert (required)"
          },
          "messageBody": {
            "type": "string",
            "example": "example string",
            "description": "Message body to prepend to actual message"
          },
          "notificationName": {
            "type": "string",
            "example": "example string",
            "description": "Name of the notification record (required)"
          },
          "opsgenieList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of opsgenie recipients"
            }
          },
          "opsrampList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of opsramp recipients"
            }
          },
          "pagerdutyList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of pagerduty recipients"
            }
          },
          "recipientList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "Non-empty list of email recipients (required)"
            }
          },
          "teamsList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of teams recipients"
            }
          },
          "webhookUrlList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of webhook_url recipients"
            }
          }
        },
        "additionalProperties": false
      },
      "v2RulelistPostRequest": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2RulelistPostResponse": {
        "type": "object",
        "properties": {
          "ruleList": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceRuleRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "alertserviceRuleRecord": {
        "type": "object",
        "properties": {
          "alarmClear": {
            "type": "string",
            "example": "example string",
            "description": "Condition for triggering recovery"
          },
          "alarmSet": {
            "type": "string",
            "example": "example string",
            "description": "Condition for triggering alert (required)"
          },
          "allowCount": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011,
            "description": "Number of entities  allowed/excluded (required)"
          },
          "category": {
            "type": "string",
            "example": "example string",
            "description": "Category of the rule (required)"
          },
          "enabled": {
            "type": "boolean",
            "example": true,
            "description": "Whether the rule is enabled or disabled (required)"
          },
          "plane": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Plane of the rule (required)"
          },
          "priority": {
            "type": "string",
            "example": 10000000,
            "description": "Priority of taking action against the rule (required)"
          },
          "ruleId": {
            "type": "string",
            "example": "example string",
            "description": "Unique id of the rule (required)"
          },
          "ruleName": {
            "type": "string",
            "example": "example string",
            "description": "Name of the rule (required)"
          }
        },
        "additionalProperties": false
      },
      "v2NotificationCreatePostRequest": {
        "type": "object",
        "properties": {
          "notificationBody": {
            "$ref": "#/components/schemas/alertserviceNotificationBody"
          },
          "ruleIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of rule ids (required)"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "notificationBody",
          "ruleIdList"
        ]
      },
      "v2NotificationCreatePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2NotificationUpdatePostRequest": {
        "type": "object",
        "properties": {
          "notificationBody": {
            "$ref": "#/components/schemas/alertserviceNotificationBody"
          },
          "notificationIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of notification ids to update (required)"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "notificationBody",
          "notificationIdList"
        ]
      },
      "v2NotificationUpdatePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2NotificationEnabledisablePostRequest": {
        "type": "object",
        "properties": {
          "enable": {
            "type": "boolean",
            "example": true,
            "description": "Enable or disable. True means enable (required)"
          },
          "notificationIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of notification ids to enable disable (required)"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "enable",
          "notificationIdList"
        ]
      },
      "v2NotificationEnabledisablePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2NotificationDeletePostRequest": {
        "type": "object",
        "properties": {
          "notificationIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of notification ids to delete notification records (required)"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "notificationIdList"
        ]
      },
      "v2NotificationDeletePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2IntegrationPostRequest": {
        "type": "object",
        "properties": {
          "integrationBody": {
            "$ref": "#/components/schemas/alertserviceCreateIntegrationBody"
          }
        },
        "additionalProperties": false,
        "required": [
          "integrationBody"
        ]
      },
      "alertserviceCreateIntegrationBody": {
        "type": "object",
        "properties": {
          "createdBy": {
            "type": "string",
            "example": "example string",
            "description": "ID of the user who created the integration"
          },
          "createdOn": {
            "$ref": "#/components/schemas/googleProtobufTimestamp"
          },
          "details": {
            "$ref": "#/components/schemas/alertserviceIntegrationDetails"
          },
          "enterprise": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011,
            "description": "ID of the enterprise (required)"
          },
          "integrationType": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Type of integration (required)"
          },
          "isActive": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the integration is active"
          },
          "nickName": {
            "type": "string",
            "example": "example string",
            "description": "Name of the integration (required)"
          }
        },
        "additionalProperties": false,
        "required": [
          "enterprise",
          "integrationType",
          "nickName"
        ]
      },
      "alertserviceIntegrationDetails": {
        "type": "object",
        "properties": {
          "opsgenieKey": {
            "type": "string",
            "example": "example string"
          },
          "opsrampDetails": {
            "type": "string",
            "example": "example string"
          },
          "pagerdutyRoutingKey": {
            "type": "string",
            "example": "example string"
          },
          "webhookUrl": {
            "type": "string",
            "example": "example string"
          },
          "zendeskDetails": {
            "$ref": "#/components/schemas/alertserviceZendeskDetails"
          }
        },
        "additionalProperties": false
      },
      "alertserviceZendeskDetails": {
        "type": "object",
        "properties": {
          "zendeskApiToken": {
            "type": "string",
            "example": "example string",
            "description": "zendesk api token (required)"
          },
          "zendeskAssigneeId": {
            "type": "string",
            "example": "example string",
            "description": "zendesk assignee id (required)"
          },
          "zendeskBaseUrl": {
            "type": "string",
            "example": "example string",
            "description": "zendesk base url (required)"
          },
          "zendeskEmail": {
            "type": "string",
            "example": "example string",
            "description": "zendesk email (required)"
          }
        },
        "additionalProperties": false,
        "required": [
          "zendeskApiToken",
          "zendeskAssigneeId",
          "zendeskBaseUrl",
          "zendeskEmail"
        ]
      },
      "v2IntegrationPostResponse": {
        "type": "object",
        "properties": {
          "integration": {
            "$ref": "#/components/schemas/alertserviceIntegration"
          }
        },
        "additionalProperties": false
      },
      "alertserviceIntegration": {
        "type": "object",
        "properties": {
          "createdBy": {
            "type": "string",
            "example": "example string"
          },
          "createdOn": {
            "type": "string",
            "example": "example string"
          },
          "details": {
            "$ref": "#/components/schemas/alertserviceIntegrationDetails"
          },
          "enterpriseId": {
            "type": "string",
            "example": "example string"
          },
          "id": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011
          },
          "isActive": {
            "type": "boolean",
            "example": true
          },
          "lastScanned": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011,
            "description": "last scanned time for integrations (zendesk)"
          },
          "nickName": {
            "type": "string",
            "example": "example string"
          },
          "type": {
            "type": "string",
            "example": "ENUM_VALUE"
          }
        },
        "additionalProperties": false
      },
      "v2IntegrationIntegrationIdPutRequest": {
        "type": "object",
        "properties": {
          "integrationBody": {
            "$ref": "#/components/schemas/alertserviceUpdateIntegrationBody"
          }
        },
        "additionalProperties": false,
        "required": [
          "integrationBody"
        ]
      },
      "alertserviceUpdateIntegrationBody": {
        "type": "object",
        "properties": {
          "details": {
            "$ref": "#/components/schemas/alertserviceIntegrationDetails"
          },
          "enterprise": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011,
            "description": "ID of the enterprise (required)"
          },
          "integrationType": {
            "type": "string",
            "example": "ENUM_VALUE",
            "description": "Type of integration (required)"
          },
          "isActive": {
            "type": "boolean",
            "example": true,
            "description": "Indicates whether the integration is active"
          },
          "nickName": {
            "type": "string",
            "example": "example string",
            "description": "nick name of the integration (required)"
          },
          "updatedBy": {
            "type": "string",
            "example": "example string",
            "description": "ID of the user who updated the integration"
          }
        },
        "additionalProperties": false,
        "required": [
          "enterprise",
          "integrationType",
          "nickName"
        ]
      },
      "v2IntegrationIntegrationIdPutResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2IntegrationIntegrationIdDeleteResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2IntegrationGetallEnterpriseIdGetResponse": {
        "type": "object",
        "properties": {
          "integrations": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceIntegration"
            }
          }
        },
        "additionalProperties": false
      },
      "v2IntegrationTestEnterpriseIdIntegrationIdGetResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AckCreateupdatePostRequest": {
        "type": "object",
        "properties": {
          "alertIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of ids of alerts to acknowledge (required)"
            }
          },
          "reason": {
            "type": "string",
            "example": "example string",
            "description": "Optional triage message in acknowledgement"
          }
        },
        "additionalProperties": false,
        "required": [
          "alertIdList"
        ]
      },
      "v2AckCreateupdatePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2RuleEnabledisablePostRequest": {
        "type": "object",
        "properties": {
          "enable": {
            "type": "boolean",
            "example": true,
            "description": "Enable or disable. True means enable (required)"
          },
          "ruleIdList": {
            "type": "array",
            "items": {
              "type": "string",
              "example": "example string",
              "description": "List of rule ids to enable/disable (required)"
            }
          }
        },
        "additionalProperties": false,
        "required": [
          "enable",
          "ruleIdList"
        ]
      },
      "v2RuleEnabledisablePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AllowlistCreatePostRequest": {
        "type": "object",
        "properties": {
          "alertId": {
            "type": "string",
            "example": "example string",
            "description": "Alert id of the alert to create allowlist/mutelist for (required)"
          },
          "noteText": {
            "type": "string",
            "example": "example string",
            "description": "Optional note"
          }
        },
        "additionalProperties": false,
        "required": [
          "alertId"
        ]
      },
      "v2AllowlistCreatePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2NotificationmutelistCreatePostRequest": {
        "type": "object",
        "properties": {
          "alertId": {
            "type": "string",
            "example": "example string",
            "description": "Alert id of the alert to create allowlist/mutelist for (required)"
          },
          "noteText": {
            "type": "string",
            "example": "example string",
            "description": "Optional note"
          }
        },
        "additionalProperties": false,
        "required": [
          "alertId"
        ]
      },
      "v2NotificationmutelistCreatePostResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AllowlistRuleIdGetResponse": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAllowAlertNotifcationListRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "alertserviceAllowAlertNotifcationListRecord": {
        "type": "object",
        "properties": {
          "createTime": {
            "type": "integer",
            "format": "int64",
            "example": 1234567891011
          },
          "deviceInterface": {
            "type": "string",
            "example": "example string"
          },
          "deviceName": {
            "type": "string",
            "example": "example string"
          },
          "enterpriseName": {
            "type": "string",
            "example": "example string"
          },
          "entityId": {
            "type": "string",
            "example": "example string"
          },
          "isWanCircuit": {
            "type": "boolean",
            "example": true
          },
          "noteText": {
            "type": "string",
            "example": "example string"
          },
          "peerDeviceInterface": {
            "type": "string",
            "example": "example string"
          },
          "peerDeviceName": {
            "type": "string",
            "example": "example string"
          },
          "ruleId": {
            "type": "string",
            "example": "example string"
          },
          "ruleName": {
            "type": "string",
            "example": "example string"
          },
          "siteName": {
            "type": "string",
            "example": "example string"
          },
          "vrfId": {
            "type": "string",
            "example": "example string"
          }
        },
        "additionalProperties": false
      },
      "v2AllowlistByEnterpriseGetResponse": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAllowAlertNotifcationListRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "v2NotificationmutelistRuleIdGetResponse": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/alertserviceAllowAlertNotifcationListRecord"
            }
          }
        },
        "additionalProperties": false
      },
      "v2NotificationmutelistDeletebyalertidAlertIdDeleteResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AllowlistDeletebyalertidAlertIdDeleteResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2NotificationmutelistDeletebyentityidEntityIdDeleteResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AllowlistDeletebyentityidEntityIdDeleteResponse": {
        "type": "object",
        "properties": {},
        "additionalProperties": false
      },
      "v2AggregatedNotificationEnableDisablePostRequest": {
        "type": "object",
        "properties": {
          "enable": {
            "type": "boolean",
            "example": true,
            "description": "Enable or disable aggregated notifications. True means enabled (required)"
          }
        },
        "additionalProperties": false,
        "required": [
          "enable"
        ]
      },
      "v2AggregatedNotificationEn

# --- truncated at 32 KB (1589 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/graphiant/refs/heads/main/openapi/graphiant-portal-openapi-original.json