{ "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 `" } }, "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" ] }, "v2AggregatedNotificationEnableDisablePostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AggregatedNotificationGetStateGetResponse": { "type": "object", "properties": { "state": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssistantVersionPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssistantVersionPostResponse": { "type": "object", "properties": { "versionId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssistantAddToConversationPostRequest": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "question": { "$ref": "#/components/schemas/assistantAssistantQuestion" } }, "additionalProperties": false }, "assistantAssistantQuestion": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "questionLanguage": { "type": "string", "example": "ENUM_VALUE" }, "questionText": { "type": "string", "example": "example string" }, "questionTimestamp": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2AssistantAddToConversationPostResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "dataframeDictionary": { "type": "array", "items": { "$ref": "#/components/schemas/assistantDataframeDictionary" } }, "originalQuestion": { "$ref": "#/components/schemas/assistantAssistantQuestion" }, "responseId": { "type": "string", "example": "example string" }, "responseLanguage": { "type": "string", "example": "ENUM_VALUE" }, "responseText": { "type": "string", "example": "example string" }, "responseTimestamp": { "type": "integer", "format": "int64", "example": 1234567891011 }, "responseType": { "type": "string", "example": "ENUM_VALUE" }, "visualizationSummary": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assistantDataframeDictionary": { "type": "object", "properties": { "dataframeDictionaryMap": { "type": "object", "additionalProperties": { "type": "string", "example": "example string" } }, "xAxis": { "type": "string", "example": "example string" }, "yAxis": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssistantGetConversationsPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assistantTimeWindow" }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assistantTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2AssistantGetConversationsPostResponse": { "type": "object", "properties": { "conversationList": { "type": "array", "items": { "$ref": "#/components/schemas/assistantAssistantConversation" } }, "enableContextHistory": { "type": "boolean", "example": true } }, "additionalProperties": false }, "assistantAssistantConversation": { "type": "object", "properties": { "conversationHeader": { "type": "string", "example": "example string" }, "conversationId": { "type": "string", "example": "example string" }, "conversationRecentTimestamp": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enableContextHistory": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssistantUpdateConversationNamePostRequest": { "type": "object", "properties": { "conversationHeader": { "type": "string", "example": "example string" }, "conversationId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssistantUpdateConversationNamePostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssistantGetConversationDetailsPostRequest": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "timeWindow": { "$ref": "#/components/schemas/assistantTimeWindow" }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssistantGetConversationDetailsPostResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "responseList": { "type": "array", "items": { "$ref": "#/components/schemas/assistantAssistantResponse" } }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assistantAssistantResponse": { "type": "object", "properties": { "conversationId": { "type": "string", "example": "example string" }, "dataframeDictionary": { "type": "array", "items": { "$ref": "#/components/schemas/assistantDataframeDictionary" } }, "originalQuestion": { "$ref": "#/components/schemas/assistantAssistantQuestion" }, "responseId": { "type": "string", "example": "example string" }, "responseLanguage": { "type": "string", "example": "ENUM_VALUE" }, "responseText": { "type": "string", "example": "example string" }, "responseTimestamp": { "type": "integer", "format": "int64", "example": 1234567891011 }, "responseType": { "type": "string", "example": "ENUM_VALUE" }, "visualizationSummary": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssistantDeleteConversationChatConversationIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssistantConversationContextHistoryPostRequest": { "type": "object", "properties": { "enable": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssistantConversationContextHistoryPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssistantConversationInterfaceEnableDisablePostRequest": { "type": "object", "properties": { "enable": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssistantConversationInterfaceEnableDisablePostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssistantConversationInterfaceStateGetResponse": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssuranceEnterprisesummaryPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "assuranceTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2AssuranceEnterprisesummaryPostResponse": { "type": "object", "properties": { "enterpriseSummary": { "$ref": "#/components/schemas/assuranceEnterpriseSummary" } }, "additionalProperties": false }, "assuranceEnterpriseSummary": { "type": "object", "properties": { "flowsAnalyzed": { "type": "integer", "format": "int64", "example": 1234567891011 }, "gapScore": { "type": "integer", "format": "int64", "example": 1234567891011 }, "prevGapScore": { "type": "integer", "format": "int64", "example": 1234567891011 }, "riskBin": { "type": "integer", "format": "int64", "example": 1234567891011 }, "threatCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "uniqueAppsCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2AssuranceScoredetailsPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceScoredetailsPostResponse": { "type": "object", "properties": { "scoreDetails": { "$ref": "#/components/schemas/assuranceScoreDetails" } }, "additionalProperties": false }, "assuranceScoreDetails": { "type": "object", "properties": { "scoreBucketList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceScoreBucketCount" } } }, "additionalProperties": false }, "assuranceScoreBucketCount": { "type": "object", "properties": { "currScore": { "type": "integer", "format": "int64", "example": 1234567891011 }, "maxScore": { "type": "integer", "format": "int64", "example": 1234567891011 }, "scoreBucketId": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceApplicationprofilesummaryPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceApplicationprofilesummaryPostResponse": { "type": "object", "properties": { "applicationProfileSummary": { "$ref": "#/components/schemas/assuranceApplicationProfileSummary" } }, "additionalProperties": false }, "assuranceApplicationProfileSummary": { "type": "object", "properties": { "bucketSummaryList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceBucketSummary" } } }, "additionalProperties": false }, "assuranceBucketSummary": { "type": "object", "properties": { "assuranceBucket": { "type": "string", "example": "ENUM_VALUE" }, "bucketColor": { "type": "string", "example": "ENUM_VALUE" }, "bucketNameToDisplay": { "type": "string", "example": "example string" }, "bucketStats": { "$ref": "#/components/schemas/assuranceBucketStats" }, "childBucketList": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "childBucketStatsList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceBucketStatsWithId" } }, "isRoot": { "type": "boolean", "example": true }, "isTerminal": { "type": "boolean", "example": true }, "parentBucketList": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "assuranceBucketStats": { "type": "object", "properties": { "prevUniqueAppCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "prevUniqueThreatCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "uniqueAppCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "uniqueThreatCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "assuranceBucketStatsWithId": { "type": "object", "properties": { "assuranceBucket": { "type": "string", "example": "ENUM_VALUE" }, "bucketNameToDisplay": { "type": "string", "example": "example string" }, "prevUniqueAppCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "uniqueAppCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2AssuranceUnclassifiedapplicationprofilesummaryPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceUnclassifiedapplicationprofilesummaryPostResponse": { "type": "object", "properties": { "applicationProfileSummary": { "$ref": "#/components/schemas/assuranceApplicationProfileSummary" } }, "additionalProperties": false }, "v2AssuranceBucketdetailsPostRequest": { "type": "object", "properties": { "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "unclassifiedOnly": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssuranceBucketdetailsPostResponse": { "type": "object", "properties": { "bucketDetails": { "$ref": "#/components/schemas/assuranceBucketDetails" } }, "additionalProperties": false }, "assuranceBucketDetails": { "type": "object", "properties": { "appCountThreatHigh": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appCountThreatLow": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appCountThreatMedium": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appIdRecords": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceAppIdRecord" } }, "appNameRecords": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceAppNameRecord" } }, "bucketNameToDisplay": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "displayIpPort": { "type": "boolean", "example": true }, "flowCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "newIpHint": { "type": "boolean", "example": true }, "recommendation": { "type": "string", "example": "example string" }, "trendValueList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceTrendValue" } }, "uniqueAppCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "assuranceAppIdRecord": { "type": "object", "properties": { "affectedHosts": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedRegions": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedSites": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedVrfs": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appIdKey": { "type": "string", "example": "example string" }, "appName": { "type": "string", "example": "example string" }, "appType": { "type": "string", "example": "ENUM_VALUE" }, "blockedPolicyList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "blockedReasonList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "category": { "type": "string", "example": "example string" }, "classficationField": { "type": "string", "example": "example string" }, "classificationField": { "type": "string", "example": "example string" }, "clients": { "type": "array", "items": { "type": "string", "example": "example string" } }, "exchangeService": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceExchangeServiceIdentifier" } }, "firstSeen": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flexAlgo": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceFlexAlgoIdentifier" } }, "flowsAnalyzed": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lastSeen": { "type": "integer", "format": "int64", "example": 1234567891011 }, "newIpHint": { "type": "boolean", "example": true }, "recommendation": { "type": "string", "example": "example string" }, "regionList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "riskStatus": { "type": "string", "example": "ENUM_VALUE" }, "serverIp": { "type": "string", "example": "example string" }, "serverPort": { "type": "string", "example": "example string" }, "siteList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "threatScore": { "type": "integer", "format": "int64", "example": 1234567891011 }, "vrfList": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "assuranceExchangeServiceIdentifier": { "type": "object", "properties": { "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "exchangeServiceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceFlexAlgoIdentifier": { "type": "object", "properties": { "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flexAlgoName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceAppNameRecord": { "type": "object", "properties": { "affectedHosts": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedRegions": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedSites": { "type": "integer", "format": "int64", "example": 1234567891011 }, "affectedVrfs": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appAiTag": { "type": "string", "example": "ENUM_VALUE" }, "appId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "appIdRecords": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceAppIdRecord" } }, "appName": { "type": "string", "example": "example string" }, "appType": { "type": "string", "example": "ENUM_VALUE" }, "category": { "type": "string", "example": "example string" }, "daClassified": { "type": "boolean", "example": true }, "exchangeService": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceExchangeServiceIdentifier" } }, "flexAlgo": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceFlexAlgoIdentifier" } }, "flowsAnalyzed": { "type": "integer", "format": "int64", "example": 1234567891011 }, "recommendation": { "type": "string", "example": "example string" }, "riskStatus": { "type": "string", "example": "ENUM_VALUE" }, "threatScore": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "assuranceTrendValue": { "type": "object", "properties": { "endTime": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flowCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "startTime": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2AssuranceApplicationdetailsbynamePostRequest": { "type": "object", "properties": { "appIdKey": { "type": "string", "example": "example string" }, "appName": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceApplicationdetailsbynamePostResponse": { "type": "object", "properties": { "appIdRecord": { "$ref": "#/components/schemas/assuranceAppIdRecord" }, "appNameRecord": { "$ref": "#/components/schemas/assuranceAppNameRecord" } }, "additionalProperties": false }, "v2AssuranceCreateclassifiedapplicationPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "ipPrefixList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "portList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "protocolList": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v2AssuranceCreateclassifiedapplicationPostResponse": { "type": "object", "properties": { "classificationEntryId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssuranceGetclassifiedapplicationlistGetResponse": { "type": "object", "properties": { "classifiedApplicationList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClassifiedApplication" } } }, "additionalProperties": false }, "assuranceClassifiedApplication": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "classificationEntryId": { "type": "string", "example": "example string" }, "ipPrefixList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "portList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "protocolList": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v2AssuranceUpdateclassifiedapplicationPostRequest": { "type": "object", "properties": { "classifiedApplicationList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClassifiedApplication" } } }, "additionalProperties": false }, "v2AssuranceUpdateclassifiedapplicationPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceDeleteclassifiedapplicationDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceCreateUserReportPostRequest": { "type": "object", "properties": { "createdOn": { "type": "integer", "format": "int64", "example": 1234567891011 }, "emailList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "pdfContent": { "type": "string", "format": "byte", "example": "Ynl0ZXM=" }, "rawContent": { "type": "array", "items": { "type": "string", "format": "byte", "example": "Ynl0ZXM=" } }, "reportName": { "type": "string", "example": "example string" }, "reportType": { "type": "string", "example": "ENUM_VALUE" }, "timePeriod": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceCreateUserReportPostResponse": { "type": "object", "properties": { "reportId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2AssuranceDeleteUserReportDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceReadUserReportListGetResponse": { "type": "object", "properties": { "userReportList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceUserReport" } } }, "additionalProperties": false }, "assuranceUserReport": { "type": "object", "properties": { "createdBy": { "type": "array", "items": { "type": "string", "example": "example string" } }, "createdOn": { "type": "integer", "format": "int64", "example": 1234567891011 }, "emailList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "enterpriseId": { "type": "string", "example": "example string" }, "reportId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "reportName": { "type": "string", "example": "example string" }, "reportType": { "type": "string", "example": "ENUM_VALUE" }, "timePeriod": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceDownloadUserReportGetResponse": { "type": "object", "properties": { "pdfContent": { "type": "string", "format": "byte", "example": "Ynl0ZXM=" } }, "additionalProperties": false }, "v2AssuranceBucketTopologiesPostRequest": { "type": "object", "properties": { "bucketId": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceBucketTopologiesPostResponse": { "type": "object", "properties": { "topologies": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceFlexAlgoIdentifier" } } }, "additionalProperties": false }, "v2AssuranceBucketServicesPostRequest": { "type": "object", "properties": { "bucketId": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceBucketServicesPostResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceExchangeServiceIdentifier" } } }, "additionalProperties": false }, "v2AssuranceBucketAppsPostRequest": { "type": "object", "properties": { "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "unclassifiedOnly": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssuranceBucketAppsPostResponse": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceBucketApp" } } }, "additionalProperties": false }, "assuranceBucketApp": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "builtinAppId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "customAppId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "exchangeService": { "$ref": "#/components/schemas/assuranceExchangeServiceIdentifier" }, "flexAlgo": { "$ref": "#/components/schemas/assuranceFlexAlgoIdentifier" }, "isDomain": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v2AssuranceBucketAppServersPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceBucketAppServersPostResponse": { "type": "object", "properties": { "appServers": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceBucketAppServer" } } }, "additionalProperties": false }, "assuranceBucketAppServer": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "appServerKey": { "type": "string", "example": "example string" }, "serverIp": { "type": "string", "example": "example string" }, "serverPort": { "type": "string", "example": "example string" }, "serverProtocol": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssuranceTopologyInventoryPostRequest": { "type": "object", "properties": { "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "topologyType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceTopologyInventoryPostResponse": { "type": "object", "properties": { "appNames": { "type": "array", "items": { "type": "string", "example": "example string" } }, "clientSites": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceSite" } }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceRegion" } }, "serverSites": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceSite" } }, "topologyChangeTs": { "type": "array", "items": { "$ref": "#/components/schemas/googleProtobufTimestamp" } } }, "additionalProperties": false }, "assuranceSite": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int32", "example": 123 }, "siteEnterpriseName": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceRegion": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int32", "example": 123 }, "regionIsoCode": { "type": "string", "example": "example string" }, "regionName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssuranceTopologyOverviewPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "appServerKey": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "filter": { "$ref": "#/components/schemas/v2AssuranceTopologyOverviewPostRequestTopologyFilter" }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "sliderTimeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "topologyTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "topologyType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2AssuranceTopologyOverviewPostRequestTopologyFilter": { "type": "object", "properties": { "clientSiteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "regionIds": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 123 } }, "serverSiteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v2AssuranceTopologyOverviewPostResponse": { "type": "object", "properties": { "numApplications": { "type": "integer", "format": "int32", "example": 123 }, "numFlows": { "type": "integer", "format": "int32", "example": 123 }, "topology": { "$ref": "#/components/schemas/assuranceTopology" }, "topologyChangeTs": { "type": "array", "items": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "trafficRegions": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssuranceTopologyOverviewPostResponseGeoregion" } } }, "additionalProperties": false }, "assuranceTopology": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceTopologyEdge" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceTopologyNode" } }, "paths": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceTopologyPath" } } }, "additionalProperties": false }, "assuranceTopologyEdge": { "type": "object", "properties": { "destinationNodeId": { "type": "string", "example": "example string" }, "performance": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceTopologyEdgeLinkPerformance" } }, "sourceNodeId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceTopologyEdgeLinkPerformance": { "type": "object", "properties": { "jitter": { "type": "number", "format": "float", "example": 12.34 }, "latency": { "type": "number", "format": "float", "example": 12.34 }, "loss": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "assuranceTopologyNode": { "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "location": { "$ref": "#/components/schemas/assuranceGeolocation" }, "name": { "type": "string", "example": "example string" }, "nodeId": { "type": "string", "example": "example string" }, "nodeType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "assuranceGeolocation": { "type": "object", "properties": { "lat": { "type": "number", "format": "float", "example": 12.34 }, "long": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "assuranceTopologyPath": { "type": "object", "properties": { "nodeIds": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v2AssuranceTopologyOverviewPostResponseGeoregion": { "type": "object", "properties": { "numSites": { "type": "integer", "format": "int32", "example": 123 }, "region": { "$ref": "#/components/schemas/assuranceRegion" } }, "additionalProperties": false }, "v2AssuranceTopologySiteSummariesPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "appServerKey": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "filter": { "$ref": "#/components/schemas/assuranceTopologyFilter" }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "assuranceTopologyFilter": { "type": "object", "properties": { "clientSiteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "regionIds": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 123 } }, "serverSiteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v2AssuranceTopologySiteSummariesPostResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssuranceTopologySiteSummariesPostResponseSummary" } } }, "additionalProperties": false }, "v2AssuranceTopologySiteSummariesPostResponseSummary": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "lanSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "sessionCount": { "type": "integer", "format": "int32", "example": 123 }, "site": { "$ref": "#/components/schemas/assuranceSite" } }, "additionalProperties": false }, "v2AssuranceTopologyClientSummariesPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "appServerKey": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "filter": { "$ref": "#/components/schemas/assuranceTopologyFilter" }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceTopologyClientSummariesPostResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSummariesPostResponseSummary" } } }, "additionalProperties": false }, "v2AssuranceTopologyClientSummariesPostResponseSummary": { "type": "object", "properties": { "appServerKey": { "type": "string", "example": "example string" }, "clientIp": { "type": "string", "example": "example string" }, "clientUsername": { "type": "string", "example": "example string" }, "lanSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "serverIp": { "type": "string", "example": "example string" }, "serverPort": { "type": "integer", "format": "int32", "example": 123 }, "serverSiteEnterpriseName": { "type": "string", "example": "example string" }, "serverSiteName": { "type": "string", "example": "example string" }, "sessionCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v2AssuranceTopologyClientSessionsPostRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "appServerKey": { "type": "string", "example": "example string" }, "bucketId": { "type": "string", "example": "ENUM_VALUE" }, "clientIp": { "type": "string", "example": "example string" }, "exchangeServiceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "filter": { "$ref": "#/components/schemas/assuranceTopologyFilter" }, "flexAlgoId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" } }, "additionalProperties": false }, "v2AssuranceTopologyClientSessionsPostResponse": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSession" } } }, "additionalProperties": false }, "assuranceClientSession": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" }, "bucket": { "type": "string", "example": "ENUM_VALUE" }, "clientEndpoint": { "$ref": "#/components/schemas/assuranceClientSessionEndpointDetails" }, "clientFlexAlgo": { "type": "string", "example": "example string" }, "clientIp": { "type": "string", "example": "example string" }, "clientLinks": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSessionEndpointLink" } }, "clientUsername": { "type": "string", "example": "example string" }, "exchangeServiceName": { "type": "string", "example": "example string" }, "firstSeenTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lanSegment": { "type": "array", "items": { "type": "string", "example": "example string" } }, "lastSeenTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "localDiaLinks": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSessionDiaLink" } }, "popLinks": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSessionPopLink" } }, "remoteDiaLinks": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSessionDiaLink" } }, "riskStatus": { "type": "string", "example": "ENUM_VALUE" }, "serverEndpoint": { "$ref": "#/components/schemas/assuranceClientSessionEndpointDetails" }, "serverFlexAlgos": { "type": "array", "items": { "type": "string", "example": "example string" } }, "serverIp": { "type": "string", "example": "example string" }, "serverLinks": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceClientSessionEndpointLink" } }, "serverPort": { "type": "integer", "format": "int32", "example": 123 }, "sessionId": { "type": "string", "example": "example string" }, "sla": { "type": "string", "example": "ENUM_VALUE" }, "slaClass": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceClientSessionEndpointDetails": { "type": "object", "properties": { "circuits": { "type": "array", "items": { "type": "string", "example": "example string" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceEdge" } }, "isGateway": { "type": "boolean", "example": true }, "jitter": { "$ref": "#/components/schemas/assuranceClientSessionEndpointDetailsStatistics" }, "latency": { "$ref": "#/components/schemas/assuranceClientSessionEndpointDetailsStatistics" }, "loss": { "$ref": "#/components/schemas/assuranceClientSessionEndpointDetailsStatistics" }, "site": { "$ref": "#/components/schemas/assuranceSite" }, "totalDownlinkUsage": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalUplinkUsage": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "assuranceEdge": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceClientSessionEndpointDetailsStatistics": { "type": "object", "properties": { "avg": { "type": "number", "format": "float", "example": 12.34 }, "max": { "type": "number", "format": "float", "example": 12.34 }, "min": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "assuranceClientSessionEndpointLink": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "jitter": { "type": "number", "format": "float", "example": 12.34 }, "latency": { "type": "number", "format": "float", "example": 12.34 }, "loss": { "type": "number", "format": "float", "example": 12.34 }, "popName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceClientSessionDiaLink": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "assuranceClientSessionPopLink": { "type": "object", "properties": { "firstPopName": { "type": "string", "example": "example string" }, "jitter": { "type": "number", "format": "float", "example": 12.34 }, "latency": { "type": "number", "format": "float", "example": 12.34 }, "loss": { "type": "number", "format": "float", "example": 12.34 }, "secondPopName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssuranceTopologyClientSessionDetailsPostRequest": { "type": "object", "properties": { "sessionId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2AssuranceTopologyClientSessionDetailsPostResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/assuranceClientSession" } }, "additionalProperties": false }, "v2AssuranceTopologyRegionSummaryPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v2AssuranceTopologyRegionSummaryPostResponse": { "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/v2AssuranceTopologyRegionSummaryPostResponseSiteEntry" } } }, "additionalProperties": false }, "v2AssuranceTopologyRegionSummaryPostResponseSiteEntry": { "type": "object", "properties": { "edgeCount": { "type": "integer", "format": "int32", "example": 123 }, "lanSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "popNames": { "type": "array", "items": { "type": "string", "example": "example string" } }, "regionName": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" }, "tags": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v2AssuranceCreateDnsproxyEntryPostRequest": { "type": "object", "properties": { "dnsproxyEntry": { "$ref": "#/components/schemas/assuranceDnsProxyEntry" } }, "additionalProperties": false }, "assuranceDnsProxyEntry": { "type": "object", "properties": { "dnsproxyEntryId": { "type": "string", "example": "example string", "description": "dns proxy table entry id (required)" }, "ipList": { "type": "array", "items": { "type": "string", "example": "example string", "description": "IP list to exclude (required)" } }, "name": { "type": "string", "example": "DNSPROXY_EXCEPTION_DNS", "description": "name of the entry (required)" }, "nameText": { "type": "string", "example": "example string", "description": "user defined name of the record (required)" }, "portList": { "type": "array", "items": { "type": "string", "example": "example string", "description": "port list to exclude (required)" } }, "protocol": { "type": "string", "example": "example string", "description": "protocol to exclude (required)" } }, "additionalProperties": false, "required": [ "dnsproxyEntryId", "ipList", "name", "nameText", "portList", "protocol" ] }, "v2AssuranceCreateDnsproxyEntryPostResponse": { "type": "object", "properties": { "dnsproxyEntryId": { "type": "string", "example": "example string", "description": "dns proxy table entry id (required)" } }, "additionalProperties": false }, "v2AssuranceUpdateDnsproxyEntryPostRequest": { "type": "object", "properties": { "dnsproxyEntry": { "$ref": "#/components/schemas/assuranceDnsProxyEntry" } }, "additionalProperties": false }, "v2AssuranceUpdateDnsproxyEntryPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceDeleteDnsproxyEntryDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceReadDnsproxyListGetResponse": { "type": "object", "properties": { "dnsproxyList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceDnsProxyEntry" } } }, "additionalProperties": false }, "v2AssuranceAiAdoptionSummaryPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/assuranceTimeWindow" }, "userListSize": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "list size of user list in where widget (required)" } }, "additionalProperties": false, "required": [ "timeWindow", "userListSize" ] }, "v2AssuranceAiAdoptionSummaryPostResponse": { "type": "object", "properties": { "topLevelKpi": { "$ref": "#/components/schemas/assuranceTopLevelKpi" }, "whatWidget": { "$ref": "#/components/schemas/assuranceWhatWidget" }, "whenWidget": { "$ref": "#/components/schemas/assuranceWhenWidget" }, "whereWidget": { "$ref": "#/components/schemas/assuranceWhereWidget" } }, "additionalProperties": false }, "assuranceTopLevelKpi": { "type": "object", "properties": { "dataTransferredKbpsMetric": { "$ref": "#/components/schemas/assuranceKpiMetric" }, "shadowAiToolsMetric": { "$ref": "#/components/schemas/assuranceKpiMetric" }, "toolsMetric": { "$ref": "#/components/schemas/assuranceKpiMetric" }, "usersMetric": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "additionalProperties": false }, "assuranceKpiMetric": { "type": "object", "properties": { "delta": { "type": "number", "format": "double", "example": 123.45, "description": "delta value for the metric" }, "name": { "type": "string", "example": "example string", "description": "name of the metric" }, "percent": { "type": "number", "format": "double", "example": 123.45, "description": "AI adoption percent for the metric" }, "tag": { "type": "string", "example": "ENUM_VALUE", "description": "AI adoption tag for the metric" }, "tokenUsage": { "type": "number", "format": "double", "example": 123.45, "description": "AI adoption token usage value" }, "value": { "type": "number", "format": "double", "example": 123.45, "description": "metric value (required)" } }, "additionalProperties": false }, "assuranceWhatWidget": { "type": "object", "properties": { "bubbleCategories": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "topToolsByActiveUsers": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "topToolsByDataTransferred": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } } }, "additionalProperties": false }, "assuranceWhenWidget": { "type": "object", "properties": { "dayOfWeek": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "hourOfDay": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "monthlyActiveUsers": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "monthlyBandwidthTransferred": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } } }, "additionalProperties": false }, "assuranceWhereWidget": { "type": "object", "properties": { "topSitesByUsers": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } }, "topUsersByDataTransferred": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceUserDefinition" } }, "topVrfsByUsers": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceKpiMetric" } } }, "additionalProperties": false }, "assuranceUserDefinition": { "type": "object", "properties": { "dataSent": { "type": "number", "format": "double", "example": 123.45, "description": "tokens sent by the user (required)" }, "managed": { "type": "boolean", "example": true, "description": "whether the user is managed (required)" }, "sessionsDay": { "type": "number", "format": "double", "example": 123.45, "description": "daily sessions for the user (required)" }, "tokensUsage": { "type": "number", "format": "double", "example": 123.45, "description": "token usage (required)" }, "tokensUsageDays": { "type": "number", "format": "double", "example": 123.45, "description": "token usage per day (required)" }, "user": { "type": "string", "example": "example string", "description": "user identifier (required)" }, "vrf": { "type": "string", "example": "example string", "description": "VRF associated with the user (required)" } }, "additionalProperties": false }, "v2AssuranceCreateAiAdoptionApproveEntryPostRequest": { "type": "object", "properties": { "approvedAppEntry": { "$ref": "#/components/schemas/assuranceApprovedAppEntryRequest" } }, "additionalProperties": false, "required": [ "approvedAppEntry" ] }, "assuranceApprovedAppEntryRequest": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string", "description": "app name to approve (required)" }, "domain": { "type": "string", "example": "example string", "description": "app name to approve" }, "id": { "type": "string", "example": "example string", "description": "approved app entry identifier" }, "tagRequested": { "type": "string", "example": "ENUM_VALUE", "description": "resulting tag, approved or shadow (required)" } }, "additionalProperties": false, "required": [ "appName", "tagRequested" ] }, "v2AssuranceCreateAiAdoptionApproveEntryPostResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "example string", "description": "identifier of the created approved app entry (required)" } }, "additionalProperties": false }, "v2AssuranceUpdateAiAdoptionApproveEntryPostRequest": { "type": "object", "properties": { "approvedAppEntry": { "$ref": "#/components/schemas/assuranceApprovedAppEntryRequest" } }, "additionalProperties": false, "required": [ "approvedAppEntry" ] }, "v2AssuranceUpdateAiAdoptionApproveEntryPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceDeleteAiAdoptionApproveEntryDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v2AssuranceReadAiAdoptionApproveEntriesGetResponse": { "type": "object", "properties": { "approvedAppList": { "type": "array", "items": { "$ref": "#/components/schemas/assuranceApprovedAppEntry" } } }, "additionalProperties": false }, "assuranceApprovedAppEntry": { "type": "object", "properties": { "activeUsers": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "number of active users (required)" }, "category": { "type": "string", "example": "example string", "description": "approved AI tool category (required)" }, "dataSentKbps": { "type": "number", "format": "double", "example": 123.45, "description": "data sent in kbps (required)" }, "id": { "type": "string", "example": "example string", "description": "approved app entry identifier (required)" }, "tool": { "type": "string", "example": "example string", "description": "approved AI tool name (required)" } }, "additionalProperties": false }, "v2AssuranceGetAppNamesPostRequest": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE", "description": "app name type to fetch (required)" } } }, "additionalProperties": false, "required": [ "tags" ] }, "v2AssuranceGetAppNamesPostResponse": { "type": "object", "properties": { "appNames": { "type": "array", "items": { "type": "string", "example": "example string", "description": "app names returned (required)" } } }, "additionalProperties": false }, "v1AuditLogsPostRequest": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "histogramBucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numLogs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonSelector" } } }, "additionalProperties": false }, "auditmonSelector": { "type": "object", "properties": { "field": { "type": "string", "example": "AuditFieldId", "description": "Field to search" }, "values": { "type": "array", "items": { "type": "string", "example": "xyz", "description": "Multiple values are treated as OR" } } }, "additionalProperties": false }, "v1AuditLogsPostResponse": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "histogram": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonHistogram" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/auditAuditEntry" } }, "totalLogs": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "auditmonHistogram": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "auditAuditEntry": { "type": "object", "properties": { "activity": { "type": "string", "example": "example string" }, "actor": { "type": "string", "example": "example string" }, "category": { "type": "string", "example": "ENUM_VALUE" }, "end": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "failedTargetResults": { "type": "array", "items": { "$ref": "#/components/schemas/auditTargetResult" } }, "info": { "type": "string", "example": "example string" }, "reason": { "type": "string", "example": "example string" }, "service": { "type": "string", "example": "ENUM_VALUE" }, "start": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/auditTargetResult" } } }, "additionalProperties": false }, "auditTargetResult": { "type": "object", "properties": { "reason": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "target": { "$ref": "#/components/schemas/auditTarget" } }, "additionalProperties": false }, "auditTarget": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ActivityLogsPostRequest": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "numLogs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "selector": { "$ref": "#/components/schemas/auditmonActivityLogsSelector" }, "selectorV2": { "$ref": "#/components/schemas/auditmonActivityLogsSelectorV2" } }, "additionalProperties": false }, "auditmonActivityLogsSelector": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "id": { "type": "string", "example": "example string" }, "inProgress": { "type": "boolean", "example": true }, "jobEntity": { "$ref": "#/components/schemas/auditActivityItem" }, "targetIds": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "auditActivityItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "auditmonActivityLogsSelectorV2": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "siteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "statuses": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "types": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "userIds": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1ActivityLogsPostResponse": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonActivityDetails" } }, "filterEntities": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/v1ActivityLogsPostResponseActivityItems" } }, "filterJobTypes": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "totalLogs": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "auditmonActivityDetails": { "type": "object", "properties": { "action": { "type": "string", "example": "example string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "category": { "type": "string", "example": "ENUM_VALUE" }, "disableAutoTimeout": { "type": "boolean", "example": true }, "endTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "string", "example": "example string" }, "initiatorType": { "type": "string", "example": "ENUM_VALUE" }, "jobEntities": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "jobType": { "type": "string", "example": "ENUM_VALUE" }, "originalEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "startTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonActivityDetailsTarget" } }, "traceSessionId": { "type": "string", "example": "example string" }, "usage": { "type": "string", "example": "ENUM_VALUE" }, "user": { "type": "string", "example": "example string" }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "auditmonActivityDetailsTarget": { "type": "object", "properties": { "detailedFailureReason": { "type": "string", "example": "example string" }, "endTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonActivityDetailsTargetEvent" } }, "failureReason": { "type": "string", "example": "example string" }, "ids": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "startTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "auditmonActivityDetailsTargetEvent": { "type": "object", "properties": { "state": { "type": "string", "example": "example string" }, "stateId": { "type": "integer", "format": "int32", "example": 123 }, "traceSessionId": { "type": "string", "example": "example string" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ActivityLogsPostResponseActivityItems": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } } }, "additionalProperties": false }, "v2AuditLogsPostRequest": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "numLogs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "selector": { "$ref": "#/components/schemas/auditmonAuditLogsV2Selector" } }, "additionalProperties": false }, "auditmonAuditLogsV2Selector": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "jobTypes": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/auditActivityItem" } }, "users": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v2AuditLogsPostResponse": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/auditmonAuditLog" } }, "totalLogs": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "auditmonAuditLog": { "type": "object", "properties": { "action": { "type": "string", "example": "example string" }, "activityId": { "type": "string", "example": "example string" }, "category": { "type": "string", "example": "ENUM_VALUE" }, "entity": { "$ref": "#/components/schemas/auditActivityItem" }, "jobType": { "type": "string", "example": "ENUM_VALUE" }, "target": { "$ref": "#/components/schemas/auditActivityItem" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "user": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ZtagentBindingsPutRequest": { "type": "object", "properties": { "customerId": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ZtagentBindingsPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ZtagentBindingsGetResponse": { "type": "object", "properties": { "customerId": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ZtagentAgentsGetResponse": { "type": "object", "properties": { "agents": { "type": "array", "items": { "$ref": "#/components/schemas/concealAgent" } }, "count": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "concealAgent": { "type": "object", "properties": { "createdAt": { "type": "string", "example": "example string" }, "disabled": { "type": "boolean", "example": true }, "id": { "type": "string", "example": "example string" }, "identifier": { "type": "string", "example": "example string" }, "lastCheckin": { "type": "string", "example": "example string" }, "machine": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdJobsJobIdGetResponse": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "jobStatus": { "$ref": "#/components/schemas/configWorkerJobStatus" } }, "additionalProperties": false }, "configWorkerJobStatus": { "type": "object", "properties": { "completedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "error": { "type": "string", "example": "example string" }, "errorCount": { "type": "integer", "format": "int32", "example": 123 }, "jobId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "jobState": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DiagnosticPingPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 10000000, "minimum": 0, "description": "Valid Provisioned device ID (required)" }, "params": { "$ref": "#/components/schemas/diagnosticToolsDiagnosticParams" }, "token": { "type": "string", "example": "example string", "description": "Identifier which was received in initial response" }, "transportType": { "type": "string", "example": "ENUM_VALUE", "description": "ICMP or TCP (required)" } }, "additionalProperties": false, "required": [ "deviceId", "transportType" ] }, "diagnosticToolsDiagnosticParams": { "type": "object", "properties": { "destAddress": { "type": "string", "example": "172.1.1.1", "description": "IPv4 or IPv6 Destination address (required)" }, "hopStatsCount": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "Per hop probes needed for traceroute hop stats" }, "interface": { "type": "string", "example": "ethernet1/0", "description": "Source Interface name" }, "payloadSize": { "type": "integer", "format": "int32", "example": 64, "minimum": 0, "description": "Size of packet to be sent" }, "port": { "type": "integer", "format": "int32", "example": 443, "minimum": 0, "description": "Valid in case of TCP ping (required)" }, "probeCount": { "type": "integer", "format": "int32", "example": 4, "minimum": 0, "description": "Number of probes to send" }, "srcAddress": { "type": "string", "example": "10.1.1.1", "description": "IPv4 or IPv6 address (required)" }, "tos": { "type": "integer", "format": "int32", "example": "0 - 7", "minimum": 0, "description": "Type of service" }, "vrfName": { "type": "string", "example": "finance", "description": "configure VRF Name (required)" } }, "additionalProperties": false, "required": [ "destAddress", "port", "srcAddress", "vrfName" ] }, "v1DiagnosticPingPostResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/diagnosticToolsDiagnosticResult" }, "token": { "type": "string", "example": "example string", "description": "Token to be sent in subsequent lookup (required)" } }, "additionalProperties": false }, "diagnosticToolsDiagnosticResult": { "type": "object", "properties": { "pingResult": { "$ref": "#/components/schemas/diagnosticToolsPingResult" }, "routeInfo": { "$ref": "#/components/schemas/diagnosticToolsRouteLookupResult" }, "traceResult": { "$ref": "#/components/schemas/diagnosticToolsTracerouteResult" } }, "additionalProperties": false }, "diagnosticToolsPingResult": { "type": "object", "properties": { "avgLoss": { "type": "number", "format": "float", "example": 64, "description": "% loss (required)" }, "avgTime": { "type": "number", "format": "double", "example": 3, "description": "Time in milli seconds (required)" }, "completedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "maxTime": { "type": "number", "format": "double", "example": 10, "description": "Time in milli seconds (required)" }, "minTime": { "type": "number", "format": "double", "example": 5, "description": "Time in milli seconds (required)" }, "result": { "type": "string", "example": "Success", "description": "Success or Failed (required)" } }, "additionalProperties": false }, "diagnosticToolsRouteLookupResult": { "type": "object", "properties": { "nexthopAddress": { "type": "string", "example": "1213:1::6451", "description": "IPv4 or IPv6 gateway address (required)" }, "outgoingInterface": { "type": "string", "example": "Ethernet0/1", "description": "Interface name (required)" }, "prefix": { "type": "string", "example": "1213:1::6451", "description": "IPv4 or IPv6 longest matching prefix (required)" } }, "additionalProperties": false }, "diagnosticToolsTracerouteResult": { "type": "object", "properties": { "hops": { "type": "array", "items": { "$ref": "#/components/schemas/diagnosticToolsHopInfo" } }, "maxLatency": { "type": "number", "format": "double", "example": 10, "description": "time in milliseconds (required)" }, "maxLatencyHost": { "type": "string", "example": "A123:3242::1111", "description": "IPv4 or IPv6 address (required)" }, "maxPathMtu": { "type": "integer", "format": "int32", "example": 1500, "minimum": 0, "description": "Path MTU (required)" }, "minPathMtu": { "type": "integer", "format": "int32", "example": 1000, "minimum": 0, "description": "Path MTU (required)" }, "result": { "type": "string", "example": "Failed", "description": "Success or Failed (required)" }, "stoppedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "diagnosticToolsHopInfo": { "type": "object", "properties": { "hostAddress": { "type": "string", "example": "1213:1::6451", "description": "IPv4 or IPv6 address (required)" }, "pathMtu": { "type": "integer", "format": "int32", "example": 1500, "minimum": 0, "description": "Path MTU for this host_address (required)" }, "roundTripTime": { "type": "number", "format": "double", "example": 10, "description": "time in milli seconds (required)" }, "stats": { "$ref": "#/components/schemas/diagnosticToolsHopStats" } }, "additionalProperties": false }, "diagnosticToolsHopStats": { "type": "object", "properties": { "avgTime": { "type": "number", "format": "double", "example": 3, "description": "Time in milli seconds (required)" }, "maxTime": { "type": "number", "format": "double", "example": 10, "description": "Time in milli seconds (required)" }, "minTime": { "type": "number", "format": "double", "example": 5, "description": "Time in milli seconds (required)" }, "rxPackets": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "Received packet count (required)" }, "stdDevTime": { "type": "number", "format": "double", "example": 3, "description": "Standard deviation of the round-trip time in milli seconds (required)" }, "txPackets": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "Transmitted packet count (required)" } }, "additionalProperties": false }, "v1DiagnosticTraceroutePostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 10000000, "minimum": 0, "description": "Valid Provisioned device ID (required)" }, "params": { "$ref": "#/components/schemas/diagnosticToolsDiagnosticParams" }, "token": { "type": "string", "example": "example string", "description": "Identifier which was received in initial response" }, "transportType": { "type": "string", "example": "ENUM_VALUE", "description": "ICMP or TCP (required)" } }, "additionalProperties": false, "required": [ "deviceId", "transportType" ] }, "v1DiagnosticTraceroutePostResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/diagnosticToolsDiagnosticResult" }, "token": { "type": "string", "example": "example string", "description": "Token to be sent in subsequent lookup (required)" } }, "additionalProperties": false }, "v1DiagnosticRebootDeviceIdPutRequest": { "type": "object", "properties": { "reason": { "type": "string", "example": "User requested reboot", "description": "Reason for reboot (required)" } }, "additionalProperties": false, "required": [ "reason" ] }, "v1DiagnosticArchivesDeviceIdGetResponse": { "type": "object", "properties": { "archives": { "type": "array", "items": { "$ref": "#/components/schemas/diagnosticToolsArchive" } } }, "additionalProperties": false }, "diagnosticToolsArchive": { "type": "object", "properties": { "archiveFileName": { "type": "string", "example": "12000.tar.zst.gpg", "description": "The archive file name" }, "archiveId": { "type": "integer", "format": "int64", "example": 1000000, "description": "Unique identifier for a specific archive" }, "archiveUrl": { "type": "string", "example": "graphiant.com/archives/134", "description": "The URL to download this archive" }, "created": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "creator": { "type": "string", "example": "8a2ec658-f25b-11ec-b939-0242ac120002", "description": "The user who requested the generation of this archive" }, "description": { "type": "string", "example": "archive requested to debug tenant A problem in device B", "description": "Description of the requested archive" }, "progress": { "type": "integer", "format": "int32", "example": 80, "description": "The upload progress of the requested debug archive in percentage" }, "status": { "type": "string", "example": "Uploaded", "description": "The status of the requested debug archive" }, "type": { "type": "string", "example": "Debug", "description": "The type of the archive" } }, "additionalProperties": false }, "v1DiagnosticArchiveEditArchiveIdPutRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "archive requested to debug tenant A problem in device B", "description": "Description of the requested archive" } }, "additionalProperties": false }, "v1DiagnosticArchiveCreateDeviceIdPostRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "archive requested to debug tenant A problem in device B", "description": "Description of the requested archive" } }, "additionalProperties": false }, "v1DiagnosticArchiveCreateDeviceIdPostResponse": { "type": "object", "properties": { "archiveId": { "type": "integer", "format": "int64", "example": 1000000, "description": "Unique identifier for a specific archive" } }, "additionalProperties": false }, "v1DiagnosticOtpDeviceIdGetResponse": { "type": "object", "properties": { "passCode": { "type": "string", "example": 123456, "description": "six digit one-time passcode to access the device" } }, "additionalProperties": false }, "v1DiagnosticBgpResetDeviceIdPutRequest": { "type": "object", "properties": { "hard": { "type": "boolean", "example": true, "description": "BGP process restarts if set to true. if false, BGP route is only relearned" }, "lanSegment": { "type": "string", "example": "isp", "description": "The segment over which this route is learned" }, "localInterface": { "type": "string", "example": "GigabitEthernet0/0/1", "description": "The local interface over which this route is learned" }, "neighbor": { "type": "string", "example": "1.1.1.1", "description": "The neighbor to reset" } }, "additionalProperties": false }, "v1DiagnosticInterfaceResetDeviceIdPutRequest": { "type": "object", "properties": { "interface": { "type": "string", "example": "GigabitEthernet0/2", "description": "interface name" } }, "additionalProperties": false }, "v1DiagnosticSpeedtestProvidersGetResponse": { "type": "object", "properties": { "provider": { "type": "array", "items": { "type": "string", "example": "Ookla", "description": "supported provider for speedtest utility" } } }, "additionalProperties": false }, "v1DiagnosticSpeedtestServersGetResponse": { "type": "object", "properties": { "server": { "type": "array", "items": { "$ref": "#/components/schemas/diagnosticToolsSpeedtestServer" } } }, "additionalProperties": false }, "diagnosticToolsSpeedtestServer": { "type": "object", "properties": { "country": { "type": "string", "example": "United Kingdom", "description": "Country of the speedtest server (required)" }, "host": { "type": "string", "example": "speedtest.fastmetrics.com", "description": "Hostname of the speedtest server (required)" }, "id": { "type": "string", "example": 29113, "description": "Server Id. Internal mapping to a server." }, "ipAddress": { "type": "string", "example": "1213:1::6451", "description": "IPv4 or IPv6 address (required)" }, "location": { "type": "string", "example": "Sheffield", "description": "Location of the speedtest server (required)" }, "name": { "type": "string", "example": "Google Fiber", "description": "Name of the speedtest server (required)" } }, "additionalProperties": false }, "v1DiagnosticSpeedtestPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 30000000555, "minimum": 0, "description": "Unique identifier for a specific device (required)" }, "params": { "$ref": "#/components/schemas/diagnosticToolsSpeedtestParams" } }, "additionalProperties": false, "required": [ "deviceId" ] }, "diagnosticToolsSpeedtestParams": { "type": "object", "properties": { "provider": { "type": "string", "example": "ookla", "description": "Speedtest provider name (required)" }, "serverId": { "type": "string", "example": 234123, "description": "This is fetched using GetSpeedtestServers API" }, "target": { "$ref": "#/components/schemas/diagnosticToolsTargetType" }, "token": { "type": "string", "example": "example string", "description": "Token to be sent in subsequent lookup" } }, "additionalProperties": false, "required": [ "provider", "target" ] }, "diagnosticToolsTargetType": { "type": "object", "properties": { "interface": { "type": "string", "example": "ethernet1/0", "description": "Source Interface name" }, "vrfName": { "type": "string", "example": "isp-red", "description": "Configured VRF Name" } }, "additionalProperties": false }, "v1DiagnosticSpeedtestPostResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/diagnosticToolsSpeedtestResult" }, "token": { "type": "string", "example": "example string", "description": "Token to be sent in subsequent lookup (required)" } }, "additionalProperties": false }, "diagnosticToolsSpeedtestResult": { "type": "object", "properties": { "avgPingTime": { "type": "number", "format": "double", "example": 3, "description": "Avg Ping Time in milli seconds (required)" }, "dateTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "downloadSpeed": { "type": "number", "format": "double", "example": 30.1, "description": "Download speed in Mbps (required)" }, "isp": { "type": "string", "example": "Google Fiber", "description": "ISP details (required)" }, "maxPingTime": { "type": "number", "format": "double", "example": 5, "description": "Max PingTime in milli seconds (required)" }, "minPingTime": { "type": "number", "format": "double", "example": 10, "description": "Min Ping Time in milli seconds (required)" }, "result": { "type": "string", "example": "Failed", "description": "Status of the speedtest operation (required)" }, "serverDetails": { "$ref": "#/components/schemas/diagnosticToolsSpeedtestServer" }, "uploadSpeed": { "type": "number", "format": "double", "example": 21, "description": "Upload speed in Mbps (required)" } }, "additionalProperties": false }, "v1DiagnosticSpeedtestReportPutRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 30000000555, "minimum": 0, "description": "Unique identifier for a specific device (required)" }, "historyLength": { "type": "integer", "format": "int64", "example": 5, "minimum": 0, "description": "Number of most recent speedtest records to return for a specific device (required)" } }, "additionalProperties": false, "required": [ "deviceId", "historyLength" ] }, "v1DiagnosticSpeedtestReportPutResponse": { "type": "object", "properties": { "report": { "type": "string", "format": "byte", "example": "[37,80,68,70,45,49,46,52,10,37,211,235,233,225,10,49,32,48,32,111,98,106,10,60,60,47,67,114,101,97,116,111,114,32,40,67,104,114,111,109,105,117,109,41,10,47,80,114,111,100,117,99,101,114,32,40,83,107,105,97,47,80,68,70,32,109,57,56,41,10,47,67,114,101,97,116,105,111,110,68,97,116,101,32,40,68,58,50,48,50,50,48,54,48,57,48,54,52,49,50,55,43,48,48,39,48,48,39,41,10,47,77,111,100,68,97,116,101,32,40,68,58,50,48,50,50,48,54,48,57,48,54,52,49,50,55,43,48,48,39,48,48]", "description": "The generated report" }, "reportId": { "type": "integer", "format": "int64", "example": 10, "description": "8 bytes (base32 encoded) identifier for the report" } }, "additionalProperties": false }, "v1DiagnosticPacketcaptureStartPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 30000000555, "description": "Unique identifier for a specific device (required)" }, "duration": { "type": "integer", "format": "int32", "example": 30, "minimum": 0, "description": "Packet capture duration. Accepted values are 30, 60, 180 (required)" }, "filter": { "$ref": "#/components/schemas/diagnosticToolsPCapFilter" }, "maxPacketCounter": { "type": "integer", "format": "int32", "example": 300, "minimum": 0, "description": "Packet capture limit." }, "target": { "$ref": "#/components/schemas/diagnosticToolsTargetType" } }, "additionalProperties": false, "required": [ "deviceId", "duration", "target" ] }, "diagnosticToolsPCapFilter": { "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/diagnosticToolsPrefixPort" }, "dscp": { "type": "integer", "format": "int32", "example": 80, "minimum": 0, "description": "Filters the packet capture for the specified DSCP field" }, "protocol": { "type": "string", "example": "Tcp", "description": "Filters the packet capture for the specified protocol" }, "source": { "$ref": "#/components/schemas/diagnosticToolsPrefixPort" } }, "additionalProperties": false }, "diagnosticToolsPrefixPort": { "type": "object", "properties": { "port": { "type": "integer", "format": "int32", "example": 80, "minimum": 0, "description": "Filters the capture for the specified port" }, "prefix": { "type": "string", "example": "1.1.1.0/24", "description": "Filters the capture for the specified prefix" } }, "additionalProperties": false }, "v1DiagnosticPacketcaptureStartPostResponse": { "type": "object", "properties": { "pcapId": { "type": "integer", "format": "int64", "example": 1000000, "description": "Unique identifier for a specific packet capture" } }, "additionalProperties": false }, "v1DiagnosticPacketcaptureStopPostRequest": { "type": "object", "properties": { "pcapId": { "type": "integer", "format": "int64", "example": 1000000, "description": "Unique identifier for a specific packet capture" } }, "additionalProperties": false }, "v1DiagnosticPacketcapturePcapIdGetResponse": { "type": "object", "properties": { "failureReason": { "type": "string", "example": "failed to access the cloud", "description": "Error message if the packet capture generation/upload failed" }, "fileName": { "type": "string", "example": "12000.tar.zst.gpg", "description": "The PCap file name." }, "status": { "type": "string", "example": "Uploaded", "description": "The status of the requested packet capture" }, "uploadProgress": { "type": "integer", "format": "int32", "example": 60, "minimum": 0, "description": "upload progress in percentage" }, "url": { "type": "string", "example": "graphiant.com/pcaps/134", "description": "The URL to download this packet capture." } }, "additionalProperties": false }, "v1DiagnosticGnmiPingGetResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/v1DiagnosticGnmiPingGetResponseResult" } } }, "additionalProperties": false }, "v1DiagnosticGnmiPingGetResponseResult": { "type": "object", "properties": { "address": { "type": "string", "example": "12001:0db8:85a3:0000:0000:8a2e:0370:7334", "description": "Address of the device on which the test was performed" }, "error": { "type": "string", "example": "device offline", "description": "If error is empty, the ping is success" }, "rtt": { "$ref": "#/components/schemas/googleProtobufDuration" }, "ttDeviceId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "googleProtobufDuration": { "type": "object", "properties": { "nanos": { "type": "integer", "format": "int32", "example": 123 }, "seconds": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DiagnosticPingStopTokenPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DiagnosticClearArpDeviceIdPutRequest": { "type": "object", "properties": { "entry": { "type": "array", "items": { "$ref": "#/components/schemas/diagnosticToolsArpEntry" } } }, "additionalProperties": false }, "diagnosticToolsArpEntry": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/diagnosticToolsArpEntryAddress" }, "allEntry": { "type": "boolean", "example": true, "description": "All IPv4 addresses" }, "interfaceName": { "type": "string", "example": "GigabitEthernet0/2", "description": "Interface Name" } }, "additionalProperties": false }, "diagnosticToolsArpEntryAddress": { "type": "object", "properties": { "address": { "type": "array", "items": { "type": "string", "example": "1.1.1.1", "description": "IPv4 addresses" } } }, "additionalProperties": false }, "v1DiagnosticResetIpsecSessionDeviceIdPutRequest": { "type": "object", "properties": { "all3RdParty": { "type": "boolean", "example": true, "description": "All 3rd Party IPSec sessions" }, "allControllers": { "type": "boolean", "example": true, "description": "All Graphiant controllers IPSec sessions" }, "allE2E": { "type": "boolean", "example": true, "description": "All Edge to Edge sessions" }, "vrf": { "type": "array", "items": { "type": "string", "example": "isp-11, isp-12", "description": "List of circuit VRFs" } } }, "additionalProperties": false }, "v1UsersEmailPasswordPatchRequest": { "type": "object", "properties": { "password": { "type": "string", "example": "newPassword123", "description": "New password for the user" } }, "required": [ "password" ] }, "v1TempPasswordPutRequest": { "type": "object", "properties": { "customerName": { "type": "string", "example": "example string" }, "emails": { "type": "array", "items": { "type": "string", "example": "example string", "description": " (required)" } }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false, "required": [ "emails" ] }, "v1TempPasswordPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1InvitationEmailPostRequest": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" }, "customerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "customerName": { "type": "string", "example": "example string", "description": " (required)" }, "isGraphiant": { "type": "boolean", "example": true }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": " (required)" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": " (required)" }, "serviceName": { "type": "string", "example": "example string", "description": " (required)" }, "serviceType": { "type": "string", "example": "example string", "description": "Extranet service type URL segment (e.g. peering_service, client_to_server)" } }, "additionalProperties": false, "required": [ "customerName", "matchId", "serviceId", "serviceName" ] }, "v1InvitationEmailPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1EnterprisesPutRequest": { "type": "object", "properties": { "accountType": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" }, "adminEmail": { "type": "string", "example": "example string" }, "adminFirstName": { "type": "string", "example": "example string" }, "adminLastName": { "type": "string", "example": "example string" }, "adminTimeZone": { "type": "string", "example": "example string" }, "cloudProvider": { "type": "string", "example": "ENUM_VALUE" }, "companyName": { "type": "string", "example": "example string", "description": " (required)" }, "creditLimit": { "type": "integer", "format": "int32", "example": 123 }, "description": { "type": "string", "example": "example string" }, "enterpriseContract": { "$ref": "#/components/schemas/commonBillingContract" }, "logo": { "type": "string", "example": "example string" }, "marketplaceId": { "type": "string", "example": "example string" }, "smallLogo": { "type": "string", "example": "example string" } }, "additionalProperties": false, "required": [ "accountType", "companyName", "enterpriseContract" ] }, "commonBillingContract": { "type": "object", "properties": { "contractedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Number of credits agreed upon for the entirety of the current contract" }, "expirationDate": { "$ref": "#/components/schemas/commonBillingTimePeriod" } }, "additionalProperties": false }, "commonBillingTimePeriod": { "type": "object", "properties": { "month": { "type": "integer", "format": "int32", "example": 123 }, "year": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1EnterprisesGetResponse": { "type": "object", "properties": { "enterprises": { "type": "array", "items": { "$ref": "#/components/schemas/iamEnterprise" } } }, "additionalProperties": false }, "iamEnterprise": { "type": "object", "properties": { "acceptEula": { "type": "boolean", "example": true }, "accountType": { "type": "string", "example": "ENUM_VALUE" }, "adminEmail": { "type": "string", "example": "example string" }, "cloudProvider": { "type": "string", "example": "ENUM_VALUE" }, "companyName": { "type": "string", "example": "example string" }, "counts": { "$ref": "#/components/schemas/iamCounts" }, "creditLimit": { "type": "integer", "format": "int32", "example": 123 }, "customers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/iamCustomer" } }, "description": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "eulaAgreementDate": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "impersonationEnabled": { "type": "boolean", "example": true }, "logo": { "type": "string", "example": "example string" }, "marketplaceId": { "type": "string", "example": "example string" }, "parentCompanyName": { "type": "string", "example": "example string" }, "parentEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "portalBanner": { "type": "string", "example": "example string" }, "proxyTenantId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "smallLogo": { "type": "string", "example": "example string" }, "tokenExpiry": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "iamCounts": { "type": "object", "properties": { "activeDownCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "activeUpCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deactivatedDownCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "downSitesCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "emptySitesCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "impairedSitesCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "stagingDownCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "stagingUpCount": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalCustomers": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalEdges": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalMsps": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalSites": { "type": "integer", "format": "int64", "example": 1234567891011 }, "upSitesCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "iamCustomer": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" }, "companyName": { "type": "string", "example": "example string" }, "counts": { "$ref": "#/components/schemas/iamCounts" }, "description": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "impersonationEnabled": { "type": "boolean", "example": true }, "marketplaceId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1EnterprisesManagedGetResponse": { "type": "object", "properties": { "counts": { "$ref": "#/components/schemas/iamCounts" }, "enterprises": { "type": "array", "items": { "$ref": "#/components/schemas/iamEnterprise" } } }, "additionalProperties": false }, "v1EnterprisesPatchRequest": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" }, "cloudProvider": { "type": "string", "example": "ENUM_VALUE" }, "companyName": { "type": "string", "example": "example string" }, "creditLimit": { "type": "integer", "format": "int32", "example": 123 }, "description": { "type": "string", "example": "example string" }, "enterpriseContract": { "$ref": "#/components/schemas/commonBillingContract" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": " (required)" }, "impersonationEnabled": { "type": "boolean", "example": true }, "logo": { "type": "string", "example": "example string" }, "marketplaceId": { "type": "string", "example": "example string" }, "portalBanner": { "type": "string", "example": "example string" }, "proxyTenantId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "smallLogo": { "type": "string", "example": "example string" }, "tokenExpiry": { "$ref": "#/components/schemas/v1EnterprisesPatchRequestTokenExpiry" } }, "additionalProperties": false, "required": [ "enterpriseId" ] }, "v1EnterprisesPatchRequestTokenExpiry": { "type": "object", "properties": { "length": { "type": "integer", "format": "int32", "example": 123 }, "timeUnit": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1EnterprisesEulaPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1AuthMfaPatchRequest": { "type": "object", "properties": { "allowedMfaTypes": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" } } }, "additionalProperties": false, "required": [ "allowedMfaTypes" ] }, "v1AuthMfaTypesGetResponse": { "type": "object", "properties": { "allowedMfaTypes": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "v1AuthMfaTypesPutRequest": { "type": "object", "properties": { "allowedMfaTypes": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" } } }, "additionalProperties": false, "required": [ "allowedMfaTypes" ] }, "v1EnterprisesEnterpriseIdAdminGetResponse": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AuthPutRequest": { "type": "object", "properties": { "cert": { "type": "string", "example": "example string", "description": " (required)" }, "entryPoint": { "type": "string", "example": "example string", "description": " (required)" }, "iamType": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" }, "issuer": { "type": "string", "example": "example string", "description": " (required)" } }, "additionalProperties": false, "required": [ "cert", "entryPoint", "iamType", "issuer" ] }, "v1AuthGetResponse": { "type": "object", "properties": { "cert": { "type": "string", "example": "example string" }, "entryPoint": { "type": "string", "example": "example string" }, "iamType": { "type": "string", "example": "ENUM_VALUE" }, "issuer": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AuthPatchRequest": { "type": "object", "properties": { "cert": { "type": "string", "example": "example string", "description": " (required)" }, "entryPoint": { "type": "string", "example": "example string", "description": " (required)" }, "iamType": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" }, "issuer": { "type": "string", "example": "example string", "description": " (required)" } }, "additionalProperties": false, "required": [ "cert", "entryPoint", "iamType", "issuer" ] }, "v1UsersPutRequest": { "type": "object", "properties": { "email": { "type": "string", "example": "example string", "description": " (required)" }, "firstName": { "type": "string", "example": "example string", "description": " (required)" }, "groupId": { "type": "string", "example": "example string" }, "lastName": { "type": "string", "example": "example string", "description": " (required)" }, "timeZone": { "type": "string", "example": "example string" } }, "additionalProperties": false, "required": [ "email", "firstName", "lastName" ] }, "v1UsersGetResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/commonUser" } } }, "additionalProperties": false }, "commonUser": { "type": "object", "properties": { "email": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "firstName": { "type": "string", "example": "example string" }, "lastActiveAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lastName": { "type": "string", "example": "example string" }, "mfaFactor": { "type": "string", "example": "example string" }, "phoneNumber": { "type": "string", "example": "example string" }, "timeZone": { "type": "string", "example": "example string" }, "userId": { "type": "string", "example": "example string" }, "verified": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1UsersIdEnterprisesGetResponse": { "type": "object", "properties": { "enterprises": { "type": "array", "items": { "$ref": "#/components/schemas/iamEnterprise" } } }, "additionalProperties": false }, "v1AccountInfoPatchRequest": { "type": "object", "properties": { "firstName": { "type": "string", "example": "example string" }, "lastName": { "type": "string", "example": "example string" }, "timeZone": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AccountEmailPatchRequest": { "type": "object", "properties": { "email": { "type": "string", "example": "example string", "description": " (required)" } }, "additionalProperties": false, "required": [ "email" ] }, "v1AccountPasswordPatchRequest": { "type": "object", "properties": { "oldPassword": { "type": "string", "example": "example string", "description": " (required)" }, "password": { "type": "string", "example": "example string", "description": " (required)" } }, "additionalProperties": false, "required": [ "oldPassword", "password" ] }, "v1UsersPasswordsExpirePostRequest": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string", "example": "example string", "description": " (required)" } } }, "additionalProperties": false, "required": [ "userIds" ] }, "v1UsersPasswordsExpirePostResponse": { "type": "object", "properties": { "failedCount": { "type": "integer", "format": "int32", "example": 123 }, "failedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/iamFailedUser" } }, "successCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "iamFailedUser": { "type": "object", "properties": { "reason": { "type": "string", "example": "example string" }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AccountMfaPutRequest": { "type": "object", "properties": { "phoneNumber": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" } }, "additionalProperties": false, "required": [ "type" ] }, "v1AccountMfaPutResponse": { "type": "object", "properties": { "confirmed": { "type": "boolean", "example": true }, "id": { "type": "string", "example": "example string" }, "qrCode": { "type": "string", "example": "example string" }, "sharedSecret": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AccountMfaConfirmationPostRequest": { "type": "object", "properties": { "code": { "type": "string", "example": "example string", "description": " (required)" }, "confirmed": { "type": "boolean", "example": true, "description": " (required)" }, "id": { "type": "string", "example": "example string", "description": " (required)" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" } }, "additionalProperties": false, "required": [ "code", "confirmed", "id", "type" ] }, "v1AccountMfaConfirmationPostResponse": { "type": "object", "properties": { "affectedUsers": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1AccountMfaGetResponse": { "type": "object", "properties": { "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1UsersIdVerifyPatchRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GroupsPutRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "example string", "description": " (required)" }, "groupId": { "type": "string", "example": "example string", "description": "Only supply if enterprise uses an idp" }, "groupType": { "type": "string", "example": "ENUM_VALUE" }, "managesEnterprises": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string", "description": " (required)" }, "permissions": { "$ref": "#/components/schemas/commonPermissions" }, "timeWindowEnd": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindowStart": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false, "required": [ "description", "name" ] }, "commonPermissions": { "type": "object", "properties": { "assetManager": { "type": "string", "example": "ENUM_VALUE" }, "b2b": { "type": "string", "example": "ENUM_VALUE" }, "b2bSecurityProfileExternal": { "type": "string", "example": "ENUM_VALUE" }, "billingAndInvoicing": { "type": "string", "example": "ENUM_VALUE" }, "compliance": { "type": "string", "example": "ENUM_VALUE" }, "developerTools": { "type": "string", "example": "ENUM_VALUE" }, "gateway": { "type": "string", "example": "ENUM_VALUE" }, "globalServices": { "type": "string", "example": "ENUM_VALUE" }, "insights": { "type": "string", "example": "ENUM_VALUE" }, "licensing": { "type": "string", "example": "ENUM_VALUE" }, "logs": { "type": "string", "example": "ENUM_VALUE" }, "monitoringAndTroubleshooting": { "type": "string", "example": "ENUM_VALUE" }, "networkConfiguration": { "type": "string", "example": "ENUM_VALUE" }, "orderStatus": { "type": "string", "example": "ENUM_VALUE" }, "reports": { "type": "string", "example": "ENUM_VALUE" }, "safetyAndSecurity": { "type": "string", "example": "ENUM_VALUE" }, "servicePolicies": { "type": "string", "example": "ENUM_VALUE" }, "support": { "type": "string", "example": "ENUM_VALUE" }, "userAndTenantManagement": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1GroupsIdMembersPostRequest": { "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "example string", "description": " (required)" } }, "replaceExisting": { "type": "boolean", "example": true } }, "additionalProperties": false, "required": [ "memberIds" ] }, "v1GroupsIdMembersDeletePostRequest": { "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "example": "example string", "description": " (required)" } } }, "additionalProperties": false, "required": [ "memberIds" ] }, "v1GroupsIdEnterprisesPostRequest": { "type": "object", "properties": { "enterpriseIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011, "description": " (required)" } } }, "additionalProperties": false, "required": [ "enterpriseIds" ] }, "v1GroupsIdMembersGetResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/commonUser" } } }, "additionalProperties": false }, "v1UsersIdGroupsGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "iamGroup": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "enterpriseIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "enterprisePermissions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/iamEnterprisePermissions" } }, "groupType": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "permissions": { "$ref": "#/components/schemas/commonPermissions" }, "timeWindowEnd": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindowStart": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "iamEnterprisePermissions": { "type": "object", "properties": { "groupType": { "type": "string", "example": "ENUM_VALUE", "description": " (required)" }, "permissions": { "$ref": "#/components/schemas/commonPermissions" } }, "additionalProperties": false }, "v1UsersIdGroupsEnterprisesGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "v1UsersIdGroupsRootGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "v1GroupsGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "v1GroupsEnterprisesGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "v1GroupsRootGetResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/iamGroup" } } }, "additionalProperties": false }, "v1GroupsIdPatchRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "displayName": { "type": "string", "example": "example string" }, "groupType": { "type": "string", "example": "ENUM_VALUE" }, "permissions": { "$ref": "#/components/schemas/commonPermissions" }, "timeWindowEnd": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindowStart": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1NatUtilizationDeviceIdGetResponse": { "type": "object", "properties": { "natUsage": { "$ref": "#/components/schemas/ipfixNatUsage" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "ipfixNatUsage": { "type": "object", "properties": { "currentCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "currentCountExtranet": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "currentCountPat": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "currentCountStatic": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "maxCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "ipfixNatEntryFilter": { "type": "object", "properties": { "destinationIp": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "insideLocalIp": { "type": "string", "example": "example string" }, "insideLocalPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "natType": { "type": "string", "example": "ENUM_VALUE" }, "outsideGlobalIp": { "type": "string", "example": "example string" }, "outsideGlobalPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vrfIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } }, "additionalProperties": false }, "commonPageRequest": { "type": "object", "properties": { "after": { "type": "string", "example": "example string" }, "before": { "type": "string", "example": "example string" }, "first": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "last": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "token": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1NatEntriesDeviceIdGetResponse": { "type": "object", "properties": { "natEntries": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixNatEntry" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "ipfixNatEntry": { "type": "object", "properties": { "destinationIpAddress": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "insideGlobalIpAddress": { "type": "string", "example": "example string" }, "insideGlobalPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "insideLocalIpAddress": { "type": "string", "example": "example string" }, "insideLocalPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "natType": { "type": "string", "example": "ENUM_VALUE" }, "outsideGlobalIpAddress": { "type": "string", "example": "example string" }, "outsideGlobalPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "preDestinationIpAddress": { "type": "string", "example": "example string" }, "preDestinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vrfId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "commonPageInfo": { "type": "object", "properties": { "currentPage": { "type": "integer", "format": "int32", "example": 1, "minimum": 0, "description": "The page number we are currently on (required)" }, "endCursor": { "type": "string", "example": "xxxxxxy", "description": "Cursor pointing to the last record on the current page" }, "hasNextPage": { "type": "boolean", "example": true, "description": "An indicator whether there is a page after this one in the resultset based on current position" }, "hasPrevPage": { "type": "boolean", "example": true, "description": "An indicator whether there is a page before this one in the resultset based on current position" }, "startCursor": { "type": "string", "example": "xxxxxx", "description": "Cursor pointing to the first record on the current page" }, "totalPages": { "type": "integer", "format": "int32", "example": 4, "minimum": 0, "description": "The number of pages in the complete resultset based on the current length of the page (required)" }, "totalRecords": { "type": "integer", "format": "int32", "example": 400, "minimum": 0, "description": "Describes the total number of records in the complete resultset (required)" } }, "additionalProperties": false }, "v1AppsBandwidthPostRequest": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "dlCircuitName": { "type": "string", "example": "example string" }, "isDia": { "type": "boolean", "example": true }, "slaClass": { "type": "string", "example": "ENUM_VALUE" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "ulCircuitName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 300, "minimum": 0, "description": "the size of the time window in seconds (required)" }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false, "required": [ "bucketSizeSec" ] }, "v1AppsBandwidthPostResponse": { "type": "object", "properties": { "stats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppBandwidthStats" } } }, "additionalProperties": false }, "ipfixAppBandwidthStats": { "type": "object", "properties": { "dlBw": { "type": "number", "format": "double", "example": 123.45, "description": "Bandwidth in kilo bits per second" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ulBw": { "type": "number", "format": "double", "example": 123.45, "description": "Bandwidth in kilo bits per second" } }, "additionalProperties": false }, "v1AppsVisualizationPostRequest": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string", "description": "Circuit name is specified if circuit apps utilization data is desired." }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isDia": { "type": "boolean", "example": true }, "slaClass": { "type": "string", "example": "ENUM_VALUE", "description": "SLA class is specified if queue apps utilization data is desired. Circuit name must be provided." }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false }, "v1AppsVisualizationPostResponse": { "type": "object", "properties": { "appHealth": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "appsOnDeviceCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "appsVisualization": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppVisualization" } }, "averageQoe": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "ipfixAppVisualization": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "appName": { "type": "string", "example": "example string" }, "circuitAvailability": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "circuitMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ipfixCircuitMetrics" } }, "currentStatus": { "type": "string", "example": "ENUM_VALUE", "description": "current status of the app." } }, "additionalProperties": false }, "ipfixCircuitMetrics": { "type": "object", "properties": { "name": { "type": "string", "example": "example string", "description": "circuit name" }, "slaClass": { "type": "string", "example": "ENUM_VALUE" }, "stats": { "$ref": "#/components/schemas/ipfixTwampMetrics" }, "usage": { "type": "number", "format": "double", "example": 123.45, "description": "usage of the circuit by the application in kilo bytes" }, "usagePct": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "ipfixTwampMetrics": { "type": "object", "properties": { "healthAvg": { "type": "string", "example": "ENUM_VALUE", "description": "calculated health average (over time window) " }, "jitter": { "type": "number", "format": "double", "example": 123.45, "description": "Jitter in ms" }, "latency": { "type": "number", "format": "double", "example": 123.45, "description": "Latency in ms" }, "loss": { "type": "number", "format": "float", "example": 12.34, "description": "Loss in percentage" }, "mos": { "type": "number", "format": "float", "example": 12.34 }, "status": { "type": "string", "example": "ENUM_VALUE", "description": "calculated status (last measured value)" } }, "additionalProperties": false }, "v1FlowsTopologyPostRequest": { "type": "object", "properties": { "appSelector": { "$ref": "#/components/schemas/ipfixAppTopologySelector" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false }, "ipfixAppTopologySelector": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Filter by app ID" }, "appName": { "type": "string", "example": "example string", "description": "Filter by application name" }, "slaClass": { "type": "string", "example": "ENUM_VALUE", "description": "Filter by SLA class" } }, "additionalProperties": false }, "v1FlowsTopologyPostResponse": { "type": "object", "properties": { "networkTopology": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixNetworkTopology" } } }, "additionalProperties": false }, "ipfixNetworkTopology": { "type": "object", "properties": { "circuitStatus": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "delta": { "$ref": "#/components/schemas/ipfixNetworkTopologyDelta" }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphEdge" } }, "flows": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Application flow count" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphNode" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false }, "ipfixNetworkTopologyDelta": { "type": "object", "properties": { "edgesAdded": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphEdge" } }, "edgesDeleted": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphEdge" } }, "nodesAdded": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphNode" } }, "nodesDeleted": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphNode" } } }, "additionalProperties": false }, "manaV2ConnectivityGraphEdge": { "type": "object", "properties": { "a": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "b": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "connections": { "$ref": "#/components/schemas/manaV2GraphiantConnections" }, "quality": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2GraphiantConnections": { "type": "object", "properties": { "controlConnection": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpsecConnection" } }, "coreConnection": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpsecConnection" } }, "managementConnection": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpsecConnection" } } }, "additionalProperties": false }, "manaV2IpsecConnection": { "type": "object", "properties": { "destIp": { "type": "string", "example": "example string" }, "destPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "lastEstablishedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "quality": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2ConnectivityGraphNode": { "type": "object", "properties": { "connections": { "$ref": "#/components/schemas/manaV2GraphiantConnections" }, "id": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "overrideRegion": { "type": "string", "example": "example string" }, "region": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1FlowsFlowTablePostRequest": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "the app ID in the question from overall visuals view" }, "appName": { "type": "string", "example": "example string" }, "cursorRef": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isDia": { "type": "boolean", "example": true }, "numFlowRecords": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Number of app flow records requested by UI." }, "selector": { "$ref": "#/components/schemas/ipfixAppFlowTableSelector" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false }, "ipfixAppFlowTableSelector": { "type": "object", "properties": { "circuitName": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Filter by circuit name(s)" } }, "slaClass": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE", "description": "Filter by SLA class(es)" } } }, "additionalProperties": false }, "v1FlowsFlowTablePostResponse": { "type": "object", "properties": { "cursorRef": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "flowTable": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppFlowTable" } } }, "additionalProperties": false }, "ipfixAppFlowTable": { "type": "object", "properties": { "destIp": { "type": "string", "example": "example string" }, "destPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dlCircuitName": { "type": "string", "example": "example string" }, "dlUsage": { "type": "number", "format": "double", "example": 123.45, "description": "Down link application usage in MB" }, "egressLocalCoreRegion": { "type": "string", "example": "example string" }, "ingressLocalCoreRegion": { "type": "string", "example": "example string" }, "lanSegment": { "type": "string", "example": "example string" }, "protocol": { "type": "string", "example": "example string" }, "remoteCoreRegion": { "type": "string", "example": "example string" }, "slaClass": { "type": "string", "example": "ENUM_VALUE" }, "srcIp": { "type": "string", "example": "example string" }, "srcPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ulCircuitName": { "type": "string", "example": "example string" }, "ulUsage": { "type": "number", "format": "double", "example": 123.45, "description": "Up link application usage in MB" } }, "additionalProperties": false }, "v1AppsAppSummaryPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isDia": { "type": "boolean", "example": true }, "timeWindow": { "$ref": "#/components/schemas/ipfixTimeWindow" } }, "additionalProperties": false }, "ipfixTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1AppsAppSummaryPostResponse": { "type": "object", "properties": { "appSummary": { "$ref": "#/components/schemas/ipfixAppStateSummaryCount" } }, "additionalProperties": false }, "ipfixAppStateSummaryCount": { "type": "object", "properties": { "appHealth": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "appIncidents": { "$ref": "#/components/schemas/ipfixAppIncidents" }, "appsOnDeviceCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "averageQoe": { "type": "number", "format": "double", "example": 123.45 }, "circuitsIncidents": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonCircuitsIncidents" } }, "circuitsIncidentsv2": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitIncidents" } } }, "additionalProperties": false }, "ipfixAppIncidents": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppIncidentsData" } } }, "additionalProperties": false }, "ipfixAppIncidentsData": { "type": "object", "properties": { "appCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "number of apps running in this time bucket" }, "appStatus": { "type": "string", "example": "ENUM_VALUE" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonCircuitsIncidents": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonCircuitsIncidentsData" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonCircuitsIncidentsData": { "type": "object", "properties": { "dlIncidents": { "$ref": "#/components/schemas/statsmonCircuitIncidents" }, "overallStatus": { "type": "string", "example": "ENUM_VALUE", "description": "Overall circuit status based on num of poor/fair incidents." }, "totalIncidents": { "$ref": "#/components/schemas/statsmonCircuitIncidents" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ulIncidents": { "$ref": "#/components/schemas/statsmonCircuitIncidents" } }, "additionalProperties": false }, "statsmonCircuitIncidents": { "type": "object", "properties": { "numFairIncidents": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numPoorIncidents": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "statsmonV2CircuitIncidents": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsData" } }, "additionalProperties": false }, "statsmonV2CircuitIncidentsData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsDataSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsSelector" } }, "additionalProperties": false }, "statsmonV2CircuitIncidentsDataSample": { "type": "object", "properties": { "dlIncidents": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsDataSampleIncidents" }, "overallStatus": { "type": "string", "example": "ENUM_VALUE", "description": "Overall circuit status based on num of poor/fair incidents." }, "totalIncidents": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsDataSampleIncidents" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ulIncidents": { "$ref": "#/components/schemas/statsmonV2CircuitIncidentsDataSampleIncidents" } }, "additionalProperties": false }, "statsmonV2CircuitIncidentsDataSampleIncidents": { "type": "object", "properties": { "numFairIncidents": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numPoorIncidents": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "statsmonV2CircuitIncidentsSelector": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1AppsDeviceDeviceIdTopPostRequest": { "type": "object", "properties": { "numApps": { "type": "integer", "format": "int32", "example": 22, "minimum": 0, "description": "The maximum number of apps to return (100 if left empty)" }, "timeWindow": { "$ref": "#/components/schemas/ipfixTimeWindow" } }, "additionalProperties": false }, "v1AppsDeviceDeviceIdTopPostResponse": { "type": "object", "properties": { "appsUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppUtilizationSummary" } }, "totalCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "ipfixAppUtilizationSummary": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "appName": { "type": "string", "example": "example string" }, "usage": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "application usage in kilo bytes" } }, "additionalProperties": false }, "v1AppsSiteSiteIdTopPostRequest": { "type": "object", "properties": { "numApps": { "type": "integer", "format": "int32", "example": 22, "minimum": 0, "description": "The maximum number of apps to return (100 if left empty)" }, "timeWindow": { "$ref": "#/components/schemas/ipfixTimeWindow" } }, "additionalProperties": false }, "v1AppsSiteSiteIdTopPostResponse": { "type": "object", "properties": { "appsUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixAppUtilizationSummary" } }, "totalCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1TalkersDeviceDeviceIdTopPostRequest": { "type": "object", "properties": { "numClients": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "The maximum number of client usage info to be returned (10 if left empty)" }, "timeWindow": { "$ref": "#/components/schemas/ipfixTimeWindow" } }, "additionalProperties": false }, "v1TalkersDeviceDeviceIdTopPostResponse": { "type": "object", "properties": { "appsUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixClientUsageSummary" } } }, "additionalProperties": false }, "ipfixClientUsageSummary": { "type": "object", "properties": { "clientIpAddress": { "type": "string", "example": "example string" }, "usage": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "data used in kilo bytes" } }, "additionalProperties": false }, "v1TalkersSiteSiteIdTopPostRequest": { "type": "object", "properties": { "numClients": { "type": "integer", "format": "int32", "example": 10, "minimum": 0, "description": "The maximum number of apps to return (10 if left empty)" }, "timeWindow": { "$ref": "#/components/schemas/ipfixTimeWindow" } }, "additionalProperties": false }, "v1TalkersSiteSiteIdTopPostResponse": { "type": "object", "properties": { "appsUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixClientUsageSummary" } } }, "additionalProperties": false }, "v1ExtranetSitesUsageTopPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v1ExtranetSitesUsageTopPostResponse": { "type": "object", "properties": { "topSites": { "type": "array", "items": { "$ref": "#/components/schemas/v1ExtranetSitesUsageTopPostResponseSiteUsage" } } }, "additionalProperties": false }, "v1ExtranetSitesUsageTopPostResponseSiteUsage": { "type": "object", "properties": { "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "the id of the site" }, "siteName": { "type": "string", "example": "Site 1", "description": "the name of the site" }, "usage": { "type": "number", "format": "double", "example": 1000000, "description": "usage/consumption of the service on the site in kilo bytes" } }, "additionalProperties": false }, "v2ExtranetTotalUsagePostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the ID associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetTotalUsagePostResponse": { "type": "object", "properties": { "usage": { "type": "number", "format": "double", "example": 1000000, "description": "total service usage in kilo bytes" } }, "additionalProperties": false }, "v2ExtranetLanSegmentsUsageTopPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetLanSegmentsUsageTopPostResponse": { "type": "object", "properties": { "topVrfs": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixEntityUsage" } } }, "additionalProperties": false }, "ipfixEntityUsage": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "id of the entity" }, "name": { "type": "string", "example": "Site 1", "description": "name of the entity" }, "usage": { "type": "number", "format": "double", "example": 1000000, "description": "usage in kbps" } }, "additionalProperties": false }, "v2ExtranetConsumersUsageTopPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id of a producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetConsumersUsageTopPostResponse": { "type": "object", "properties": { "topConsumers": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixEntityUsage" } }, "totalCustomers": { "type": "integer", "format": "int64", "example": 10, "description": "total number of customers" }, "totalUsage": { "type": "number", "format": "double", "example": 1000000, "description": "total service usage in kilo bytes" } }, "additionalProperties": false }, "v2ExtranetServiceOvertimeConsumptionPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site" }, "subscriptionName": { "type": "string", "example": "example string", "description": "Optional subscription name for filter" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific vrf" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetServiceOvertimeConsumptionPostResponse": { "type": "object", "properties": { "dlAggStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } }, "ulAggStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } } }, "additionalProperties": false }, "ipfixStats": { "type": "object", "properties": { "avgUsage": { "type": "number", "format": "double", "example": 1000000, "description": "Average service usage in kbps" }, "peakUsage": { "type": "number", "format": "double", "example": 1000000, "description": "Peak service usage in kbps" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2ExtranetSitesConsumptionOverviewPostRequest": { "type": "object", "properties": { "customerName": { "type": "string", "example": "Customer 1", "description": "a filter to get usage for a specific customer" }, "flippedView": { "type": "boolean", "example": true, "description": "whether to view the data from the consumer's perspective (true) or the provider's perspective (false) (required)" }, "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific vrf" } }, "additionalProperties": false, "required": [ "flippedView", "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetSitesConsumptionOverviewPostResponse": { "type": "object", "properties": { "lanSegments": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "totalUsage": { "type": "number", "format": "double", "example": 1000000, "description": "total service usage in kilo bytes" } }, "additionalProperties": false }, "ipfixConnectionMap": { "type": "object", "properties": { "connections": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "connectionsV2": { "type": "object", "additionalProperties": { "type": "number", "format": "double", "example": 123.45 } }, "name": { "type": "string", "example": "Site 1", "description": "the name of the connection" } }, "additionalProperties": false }, "v2ExtranetSitesUsagePostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, or service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site (id of the site)" }, "subscriptionName": { "type": "string", "example": "example string", "description": "Optional subscription name for filter" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific lan segment (id of the lan segment)" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v2ExtranetSitesUsagePostResponse": { "type": "object", "properties": { "bwAllocation": { "type": "integer", "format": "int32", "example": 1000000, "description": "the bandwidth allocation for the entity in kbps" }, "dlStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } }, "ulStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceConsumersUsageTopPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id of a producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v1ExtranetB2bMonitoringPeeringServiceConsumersUsageTopPostResponse": { "type": "object", "properties": { "topConsumers": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixEntityUsage" } }, "totalCustomers": { "type": "integer", "format": "int64", "example": 10, "description": "total number of customers" }, "totalUsage": { "type": "number", "format": "double", "example": 1000000, "description": "total service usage in kilo bytes" } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceBandwidthUsagePostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, or service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site (id of the site)" }, "subscriptionName": { "type": "string", "example": "example string", "description": "Optional subscription name for filter" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific lan segment (id of the lan segment)" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v1ExtranetB2bMonitoringPeeringServiceBandwidthUsagePostResponse": { "type": "object", "properties": { "bwAllocation": { "type": "integer", "format": "int32", "example": 1000000, "description": "the bandwidth allocation for the entity in kbps" }, "dlStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } }, "ulStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceConsumptionOverviewPostRequest": { "type": "object", "properties": { "customerName": { "type": "string", "example": "Customer 1", "description": "a filter to get usage for a specific customer" }, "flippedView": { "type": "boolean", "example": true, "description": "whether to view the data from the consumer's perspective (true) or the provider's perspective (false) (required)" }, "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific vrf" } }, "additionalProperties": false, "required": [ "flippedView", "id", "isB2B", "isProvider", "timeWindow" ] }, "v1ExtranetB2bMonitoringPeeringServiceConsumptionOverviewPostResponse": { "type": "object", "properties": { "firstLevel": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "secondLevel": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "thirdLevel": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixConnectionMap" } }, "totalUsage": { "type": "number", "format": "double", "example": 1000000, "description": "total service usage in kilo bytes" } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceServiceOvertimeConsumptionPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "siteId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific site" }, "subscriptionName": { "type": "string", "example": "example string", "description": "Optional subscription name for filter" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" }, "vrfId": { "type": "integer", "format": "int64", "example": 1, "description": "a filter to get usage for a specific vrf" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider", "timeWindow" ] }, "v1ExtranetB2bMonitoringPeeringServiceServiceOvertimeConsumptionPostResponse": { "type": "object", "properties": { "dlAggStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } }, "ulAggStats": { "type": "array", "items": { "$ref": "#/components/schemas/ipfixStats" } } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceServiceCustomerListPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "service id (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" }, "timeWindow": { "$ref": "#/components/schemas/statsmonTimeWindow" } }, "additionalProperties": false, "required": [ "id", "isProvider", "timeWindow" ] }, "v1ExtranetB2bMonitoringPeeringServiceServiceCustomerListPostResponse": { "type": "object", "properties": { "customerName": { "type": "array", "items": { "type": "string", "example": "example string", "description": "the list of customer names" } } }, "additionalProperties": false }, "manaV2DeviceFilter": { "type": "object", "properties": { "hostname": { "type": "string", "example": "example string" }, "list": { "type": "string", "example": "ENUM_VALUE" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DevicesGetResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Device" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" } }, "additionalProperties": false }, "manaV2Device": { "type": "object", "properties": { "bgp": { "$ref": "#/components/schemas/manaV2BgpInstance" }, "bgpEnabled": { "type": "boolean", "example": true }, "circuits": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Circuit" } }, "configUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "dhcpServerEnabled": { "type": "boolean", "example": true }, "dns": { "$ref": "#/components/schemas/manaV2Dns" }, "gdi": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "hostname": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Interface" } }, "internalState": { "type": "string", "example": "ENUM_VALUE" }, "ipfixEnabled": { "type": "boolean", "example": true }, "ipfixExporters": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpfixExporter" } }, "ipsecTunnels": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteToSiteIPsec" } }, "lastBootedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lldpEnabled": { "type": "boolean", "example": true }, "localRouteTag": { "$ref": "#/components/schemas/manaV2RouteTag" }, "localWebServerPassword": { "type": "string", "example": "example string" }, "location": { "$ref": "#/components/schemas/manaV2Location" }, "maintenanceMode": { "type": "boolean", "example": true }, "natPolicy": { "$ref": "#/components/schemas/manaV2NatPolicy" }, "notes": { "type": "string", "example": "example string" }, "ntp": { "$ref": "#/components/schemas/manaV2Ntp" }, "operStaled": { "type": "boolean", "example": true }, "operStaledAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "operUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ospfv2Enabled": { "type": "boolean", "example": true }, "ospfv3Enabled": { "type": "boolean", "example": true }, "platform": { "type": "string", "example": "example string" }, "prefixSets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PrefixSet" } }, "rebootReason": { "type": "string", "example": "example string" }, "region": { "$ref": "#/components/schemas/manaV2Region" }, "regionOverride": { "$ref": "#/components/schemas/manaV2Region" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "routingPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RoutingPolicy" } }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Vrf" } }, "serialNumber": { "type": "string", "example": "example string" }, "site": { "$ref": "#/components/schemas/manaV2Site" }, "slaConformance": { "$ref": "#/components/schemas/manaV2SlaConformance" }, "snmp": { "$ref": "#/components/schemas/manaV2Snmp" }, "softwareVersion": { "type": "string", "example": "example string" }, "staticRoutesEnabled": { "type": "boolean", "example": true }, "status": { "type": "string", "example": "ENUM_VALUE" }, "trafficPolicy": { "$ref": "#/components/schemas/manaV2ForwardingPolicy" }, "uptime": { "$ref": "#/components/schemas/googleProtobufDuration" }, "vrrpEnabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BgpInstance": { "type": "object", "properties": { "asn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "routerId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2Circuit": { "type": "object", "properties": { "bgpAggregations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpAggregation" } }, "bgpMultipath": { "$ref": "#/components/schemas/manaV2BgpMultipath" }, "bgpNeighbors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpNeighbor" } }, "bgpRedistributions": { "$ref": "#/components/schemas/manaV2BgpRedistribute" }, "carrier": { "type": "string", "example": "example string" }, "circuitType": { "type": "string", "example": "ENUM_VALUE" }, "connectionType": { "type": "string", "example": "ENUM_VALUE" }, "coreLogicalInterfacesV2": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2CircuitInterface" } }, "description": { "type": "string", "example": "example string" }, "diaEnabled": { "type": "boolean", "example": true }, "diaSnmpIndex": { "type": "integer", "format": "int64", "example": 1234567891011 }, "discoveredPublicIp": { "type": "string", "example": "example string" }, "dropMechanism": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaceName": { "type": "string", "example": "example string" }, "label": { "type": "string", "example": "ENUM_VALUE" }, "lastResort": { "type": "boolean", "example": true }, "linkDownSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "linkUpSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "loopback": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "patAddresses": { "type": "array", "items": { "type": "string", "example": "example string" } }, "privateIp": { "type": "string", "example": "example string" }, "profile": { "$ref": "#/components/schemas/manaV2QoSProfile" }, "qosProfile": { "type": "string", "example": "ENUM_VALUE" }, "qosProfileType": { "type": "string", "example": "ENUM_VALUE" }, "snmpIndex": { "type": "integer", "format": "int64", "example": 1234567891011 }, "staticRoutes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2StaticRoute" } }, "wanInterfaceV2": { "$ref": "#/components/schemas/manaV2CircuitInterface" } }, "additionalProperties": false }, "manaV2BgpAggregation": { "type": "object", "properties": { "asSet": { "type": "boolean", "example": true }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "prefix": { "type": "string", "example": "example string" }, "summaryOnly": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BgpMultipath": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2BgpNeighbor": { "type": "object", "properties": { "addressFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpNeighborAddressFamily" } }, "allowAsIn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "asOverride": { "type": "boolean", "example": true }, "bfd": { "$ref": "#/components/schemas/manaV2BfdInstance" }, "bfdNeighbor": { "$ref": "#/components/schemas/manaV2BfdNeighbor" }, "bgpType": { "type": "string", "example": "ENUM_VALUE" }, "defaultOriginate": { "type": "string", "example": "ENUM_VALUE", "description": "Set when default route needs to be advertised in BGP domain" }, "dynamicNeighborPeers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpDynamicNeighborOperPeer" } }, "enabled": { "type": "boolean", "example": true }, "holdTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "keepaliveTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "localAddress": { "type": "string", "example": "example string" }, "localInterface": { "type": "string", "example": "example string" }, "maxPrefix": { "type": "integer", "format": "int32", "example": 10000, "minimum": 0, "description": "Maximum number of prefixes that can be received from neighbor" }, "md5Password": { "type": "string", "example": "example string" }, "multiHop": { "type": "integer", "format": "int32", "example": 5, "minimum": 0, "description": "Set when EBGP multi-hop functionality is enabled" }, "peerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "remoteAddress": { "type": "string", "example": "example string" }, "removePrivateAs": { "type": "boolean", "example": true }, "sendCommunity": { "type": "boolean", "example": true, "description": "Flag for sending standard, extended, and large communities" }, "state": { "type": "string", "example": "ENUM_VALUE" }, "timeSinceLastOperChange": { "$ref": "#/components/schemas/googleProtobufDuration" }, "up": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BgpNeighborAddressFamily": { "type": "object", "properties": { "addressFamily": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "inboundPolicy": { "type": "string", "example": "example string" }, "outboundPolicy": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2BfdInstance": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "minimumInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "multiplier": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2BfdNeighbor": { "type": "object", "properties": { "desiredMinimumTxInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ifIndex": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "interface": { "type": "string", "example": "example string" }, "lastUpdated": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "localDiag": { "type": "string", "example": "ENUM_VALUE" }, "peerAddress": { "type": "string", "example": "example string" }, "remoteDiag": { "type": "string", "example": "ENUM_VALUE" }, "requiredMinimumRxInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "segmentName": { "type": "string", "example": "example string" }, "sourceAddress": { "type": "string", "example": "example string" }, "state": { "type": "string", "example": "ENUM_VALUE" }, "timeInState": { "$ref": "#/components/schemas/googleProtobufDuration" }, "up": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BgpDynamicNeighborOperPeer": { "type": "object", "properties": { "lastOperStatusChange": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "localAddress": { "type": "string", "example": "example string", "description": "Local address used for this peer session, if known from oper" }, "operStatus": { "type": "boolean", "example": true, "description": "True when the BGP session to this peer is operationally up (e.g. established)" }, "peerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Peer ASN from oper, if reported" }, "remoteAddress": { "type": "string", "example": "example string", "description": "Peer address from device oper state (IPv4/IPv6; may include IPv6 zone id)" }, "state": { "type": "string", "example": "ENUM_VALUE", "description": "BGP FSM state for this peer session" } }, "additionalProperties": false }, "manaV2BgpRedistribute": { "type": "object", "properties": { "bgp": { "type": "boolean", "example": true }, "connected": { "type": "boolean", "example": true }, "dia": { "type": "boolean", "example": true }, "ospfv2": { "type": "boolean", "example": true }, "static": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2CircuitInterface": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "operStatus": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2QoSProfile": { "type": "object", "properties": { "kind": { "type": "string", "example": "ENUM_VALUE" }, "profile": { "type": "string", "example": "ENUM_VALUE" }, "queues": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2QoSProfileQueue" } } }, "additionalProperties": false }, "manaV2QoSProfileQueue": { "type": "object", "properties": { "bandwidthPercent": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "defaultQueue": { "type": "boolean", "example": true }, "slaClass": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2StaticRoute": { "type": "object", "properties": { "administrativeDistance": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "nextHop": { "$ref": "#/components/schemas/manaV2StaticRouteNexthop" }, "nextHops": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2StaticRouteNexthop" } }, "prefix": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2StaticRouteNexthop": { "type": "object", "properties": { "circuit": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "metric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "nextHopAddress": { "type": "string", "example": "example string" }, "nexthop": { "type": "string", "example": "example string" }, "outgoingInterface": { "type": "string", "example": "example string" }, "thirdPartyIpsecTunnel": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2Dns": { "type": "object", "properties": { "cloudflareServers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DnsipAddress" } }, "dynamicServers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DnsipAddress" } }, "dynamicServersV2": { "$ref": "#/components/schemas/manaV2DynamicDnsServers" }, "mode": { "type": "string", "example": "ENUM_VALUE" }, "staticServers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DnsipAddress" } }, "staticServersV2": { "$ref": "#/components/schemas/manaV2StaticDnsServers" } }, "additionalProperties": false }, "manaV2DnsipAddress": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "interfaceName": { "type": "string", "example": "example string" }, "ipv4": { "type": "string", "example": "example string" }, "ipv6": { "type": "string", "example": "example string" }, "source": { "type": "string", "example": "example string" }, "stale": { "type": "boolean", "example": true }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2DynamicDnsServers": { "type": "object", "properties": { "circuit": { "type": "string", "example": "example string" }, "servers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2DnsipAddresses" } } }, "additionalProperties": false }, "manaV2DnsipAddresses": { "type": "object", "properties": { "dynamicServers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DnsipAddress" } } }, "additionalProperties": false }, "manaV2StaticDnsServers": { "type": "object", "properties": { "primaryIpv4Server": { "$ref": "#/components/schemas/manaV2DnsipAddress" }, "primaryIpv6Server": { "$ref": "#/components/schemas/manaV2DnsipAddress" }, "secondaryIpv4Server": { "$ref": "#/components/schemas/manaV2DnsipAddress" }, "secondaryIpv6Server": { "$ref": "#/components/schemas/manaV2DnsipAddress" } }, "additionalProperties": false }, "manaV2Interface": { "type": "object", "properties": { "alias": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "circuitName": { "type": "string", "example": "example string" }, "configUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "configuredMaxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "description": { "type": "string", "example": "example string" }, "duplex": { "type": "string", "example": "example string" }, "enabled": { "type": "boolean", "example": true }, "gatewayAddressV4": { "type": "string", "example": "example string" }, "gatewayAddressV6": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipSec": { "$ref": "#/components/schemas/manaV2InterfaceIPsec" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceAddress" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceAddress" }, "ipv6Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2InterfaceAddress" } }, "lagInterface": { "$ref": "#/components/schemas/manaV2LagInterface" }, "lan": { "type": "string", "example": "example string" }, "lldpEnabled": { "type": "boolean", "example": true }, "macsec": { "$ref": "#/components/schemas/manaV2InterfaceMaCsec" }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "operUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "phyAddress": { "type": "string", "example": "example string" }, "protocol": { "type": "string", "example": "ENUM_VALUE" }, "securityZone": { "type": "string", "example": "example string" }, "sfpOpticalStrength": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2InterfaceSfpOpticalStrength" } }, "speedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "subinterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2InterfaceVlan" } }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "type": { "type": "string", "example": "ENUM_VALUE" }, "up": { "type": "boolean", "example": true }, "vrfFunctionId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2InterfaceIPsec": { "type": "object", "properties": { "antiReplayWindowSize": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dhGroup": { "type": "string", "example": "ENUM_VALUE" }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "encryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "esn": { "type": "boolean", "example": true }, "establishedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ikeIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "ipsecEncryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "ipsecIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "label": { "type": "string", "example": "ENUM_VALUE" }, "localAddress": { "type": "string", "example": "example string" }, "localCircuit": { "type": "string", "example": "example string" }, "localIkePeerIdentity": { "type": "string", "example": "example string" }, "localIkesaSpi": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "localPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "negotiatedAlgo": { "type": "string", "example": "example string" }, "operState": { "type": "boolean", "example": true }, "perfectForwardSecrecy": { "type": "string", "example": "example string" }, "presharedKey": { "type": "string", "example": "example string" }, "protocol": { "type": "string", "example": "example string" }, "reauthInterval": { "type": "integer", "format": "int64", "example": 1234567891011 }, "rekeyInterval": { "type": "integer", "format": "int64", "example": 1234567891011 }, "remoteAddress": { "type": "string", "example": "example string" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string" }, "remoteIkesaSpi": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "remotePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2InterfaceAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" }, "dhcpClient": { "type": "boolean", "example": true }, "dhcpRelay": { "$ref": "#/components/schemas/manaV2DhcpRelay" }, "dhcpServer": { "type": "boolean", "example": true }, "origin": { "type": "string", "example": "ENUM_VALUE" }, "vrrpGroup": { "$ref": "#/components/schemas/manaV2VrrpGroup" } }, "additionalProperties": false }, "manaV2DhcpRelay": { "type": "object", "properties": { "dhcpv4Relays": { "type": "array", "items": { "type": "string", "example": "example string" } }, "dhcpv6Relays": { "type": "array", "items": { "type": "string", "example": "example string" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2VrrpGroup": { "type": "object", "properties": { "acceptMode": { "type": "boolean", "example": true }, "allowInterOperability": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "example string" }, "effectivePriority": { "type": "integer", "format": "int32", "example": 123 }, "enabled": { "type": "boolean", "example": true }, "groupMembers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2VRRPGroupMember" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "preempt": { "type": "boolean", "example": true }, "priority": { "type": "integer", "format": "int32", "example": 123 }, "state": { "type": "string", "example": "ENUM_VALUE" }, "trackedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2VRRPGroupInterfacePriorityDecrement" } }, "virtualIpAddress": { "type": "string", "example": "example string" }, "virtualMacAddress": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2VRRPGroupMember": { "type": "object", "properties": { "circuit": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "effectivePriority": { "type": "integer", "format": "int32", "example": 123 }, "hostname": { "type": "string", "example": "example string" }, "interface": { "type": "string", "example": "example string" }, "lan": { "type": "string", "example": "example string" }, "localIpAddress": { "type": "string", "example": "example string" }, "priority": { "type": "integer", "format": "int32", "example": 123 }, "state": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2VRRPGroupInterfacePriorityDecrement": { "type": "object", "properties": { "interface": { "type": "string", "example": "example string" }, "priorityDecrement": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2LagInterface": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lacpConfig": { "$ref": "#/components/schemas/manaV2LacpConfig" }, "members": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "minimumMembers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2LacpConfig": { "type": "object", "properties": { "mode": { "type": "string", "example": "ENUM_VALUE" }, "timer": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2InterfaceMaCsec": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "encryptionEnforcementMode": { "type": "string", "example": "ENUM_VALUE" }, "keyServerPriority": { "type": "integer", "format": "int64", "example": 1234567891011 }, "pskConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PskConfiguration" } }, "sakConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SakConfiguration" } }, "splitSakConfigByLagMember": { "type": "boolean", "example": true }, "transparentVlan": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2PskConfiguration": { "type": "object", "properties": { "cak": { "type": "string", "example": "1234567890abcdef1234567890abcdef", "description": "The Connection Authentication Key (CAK)" }, "cakCryptographicAlgorithm": { "type": "string", "example": "AES_128_CMAC", "description": "The cryptographic algorithm for the CAK, SAK Cipher Suite is implicitly selected based on this field. (required)" }, "ckn": { "type": "string", "example": "Corp-MACsec-CKN", "description": "The Connection Key Name (CKN) (required)" }, "nickname": { "type": "string", "example": "PSK1", "description": "The nickname of the PSK (required)" }, "startTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "useXpnForCipherSuite": { "type": "boolean", "example": true, "description": "Whether to use XPN for the cipher suite. If true, AES_128_GCM_XPN or AES_256_GCM_XPN is selected based on the cmac algorithm. If false, AES_128_GCM or AES_256_GCM is selected based on the cmac algorithm." } }, "additionalProperties": false }, "manaV2SakConfiguration": { "type": "object", "properties": { "cipherSuite": { "type": "string", "example": "ENUM_VALUE" }, "lagMemberInterfaceId": { "type": "integer", "format": "int64", "example": 1, "description": "The interface ID (required for when each lag member has a different MACsec configuration - when split_sak_config_by_lag_member is true) (required)" }, "nullableRekeyInterval": { "$ref": "#/components/schemas/manaV2NullableMaCsecRekeyInterval" }, "nullableReplayProtectionWindowSize": { "$ref": "#/components/schemas/manaV2NullableMaCsecReplayProtectionWindowSize" }, "rekeyInterval": { "type": "integer", "format": "int64", "example": 1234567891011 }, "replayProtectionWindowSize": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableMaCsecRekeyInterval": { "type": "object", "properties": { "rekeyInterval": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableMaCsecReplayProtectionWindowSize": { "type": "object", "properties": { "replayProtectionWindowSize": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2InterfaceSfpOpticalStrength": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "rxPower": { "type": "number", "format": "float", "example": 12.34 }, "txBias": { "type": "number", "format": "float", "example": 12.34 }, "txPower": { "type": "number", "format": "float", "example": 12.34 }, "voltage": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "manaV2InterfaceVlan": { "type": "object", "properties": { "alias": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "configUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "description": { "type": "string", "example": "example string" }, "duplex": { "type": "string", "example": "example string" }, "enabled": { "type": "boolean", "example": true }, "gatewayAddressV4": { "type": "string", "example": "example string" }, "gatewayAddressV6": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceAddress" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceAddress" }, "ipv6Addresses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2InterfaceAddress" } }, "lan": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "operUpdatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "parentMacAddress": { "type": "string", "example": "example string" }, "securityZone": { "type": "string", "example": "example string" }, "speedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "up": { "type": "boolean", "example": true }, "vlan": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2IpfixExporter": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "monitoredSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "name": { "type": "string", "example": "example string" }, "sampleMode": { "type": "string", "example": "example string" }, "sampleRate": { "type": "integer", "format": "int64", "example": 1234567891011 }, "sourceAddress": { "type": "string", "example": "example string" }, "sourceInterface": { "type": "string", "example": "example string" }, "sourceSegment": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SiteToSiteIPsec": { "type": "object", "properties": { "bgp": { "$ref": "#/components/schemas/manaV2SiteToSiteIPsecIPsecBgpRoutes" }, "destinationAddress": { "type": "string", "example": "example string" }, "ikeInitiator": { "type": "boolean", "example": true }, "ipsecLabel": { "type": "string", "example": "ENUM_VALUE" }, "lan": { "type": "string", "example": "example string" }, "localAddressV4": { "type": "string", "example": "example string" }, "localAddressV6": { "type": "string", "example": "example string" }, "localCircuit": { "type": "string", "example": "example string" }, "localIkePeerIdentity": { "type": "string", "example": "example string" }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "presharedKey": { "type": "string", "example": "example string" }, "remoteAddressV4": { "type": "string", "example": "example string" }, "remoteAddressV6": { "type": "string", "example": "example string" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string" }, "static": { "$ref": "#/components/schemas/manaV2SiteToSiteIPsecIPsecStaticRoutes" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vpnProfile": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SiteToSiteIPsecIPsecBgpRoutes": { "type": "object", "properties": { "addressFamilies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpNeighborAddressFamily" } }, "holdTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "keepaliveTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "md5Password": { "type": "string", "example": "example string" }, "peerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sendCommunity": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2SiteToSiteIPsecIPsecStaticRoutes": { "type": "object", "properties": { "destinationPrefix": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2RouteTag": { "type": "object", "properties": { "levelOne": { "type": "string", "example": "example string" }, "levelTwo": { "type": "string", "example": "example string" }, "levelZero": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2Location": { "type": "object", "properties": { "addressLine1": { "type": "string", "example": "example string" }, "addressLine2": { "type": "string", "example": "example string" }, "city": { "type": "string", "example": "example string" }, "country": { "type": "string", "example": "example string" }, "countryCode": { "type": "string", "example": "example string" }, "latitude": { "type": "number", "format": "double", "example": 123.45 }, "longitude": { "type": "number", "format": "double", "example": 123.45 }, "notes": { "type": "string", "example": "example string" }, "provinceCode": { "type": "string", "example": "example string" }, "state": { "type": "string", "example": "example string" }, "stateCode": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NatPolicy": { "type": "object", "properties": { "natPolicyRulesets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NatPolicyRuleset" } } }, "additionalProperties": false }, "manaV2NatPolicyRuleset": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NATPolicyRulesetRule" } } }, "additionalProperties": false }, "manaV2NATPolicyRulesetRule": { "type": "object", "properties": { "advertisePreNatPrefixes": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "originalDstIpPrefix": { "type": "string", "example": "example string" }, "originalSrcIpPrefix": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "translatedDstIpPrefix": { "type": "string", "example": "example string" }, "translatedSrcIpPrefix": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2Ntp": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string", "example": "example string" } }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2PrefixSet": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PrefixSetEntry" } }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "mode": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PrefixSetPolicy" } }, "policyCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2PrefixSetEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipPrefix": { "type": "string", "example": "example string" }, "maskLower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "maskUpper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2PrefixSetPolicy": { "type": "object", "properties": { "attachPoint": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2Region": { "type": "object", "properties": { "coordinates": { "$ref": "#/components/schemas/manaV2RegionCoordinates" }, "id": { "type": "integer", "format": "int32", "example": 123 }, "name": { "type": "string", "example": "example string" }, "regionIsoCode": { "type": "string", "example": "example string" }, "unavailable": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2RegionCoordinates": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "example": 123.45 }, "longitude": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "manaV2RoutingPolicy": { "type": "object", "properties": { "attachPoint": { "type": "string", "example": "ENUM_VALUE" }, "defaultAction": { "type": "string", "example": "ENUM_VALUE" }, "description": { "type": "string", "example": "example string" }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "statements": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RoutingPolicyStatement" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2RoutingPolicyStatement": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RoutingPolicyStatementAction" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RoutingPolicyStatementMatch" } }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2RoutingPolicyStatementAction": { "type": "object", "properties": { "administrativeDistance": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "aspathPrepend": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpSetNextHop": { "type": "string", "example": "example string" }, "callPolicy": { "type": "string", "example": "example string" }, "community": { "$ref": "#/components/schemas/manaV2CommunityType" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "localPref": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "metricAbsolute": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "metricModifier": { "type": "integer", "format": "int32", "example": 123 }, "result": { "type": "string", "example": "ENUM_VALUE" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "weight": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2CommunityType": { "type": "object", "properties": { "additive": { "type": "boolean", "example": true }, "communityList": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2RoutingPolicyStatementMatch": { "type": "object", "properties": { "community": { "type": "array", "items": { "type": "string", "example": "example string" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "prefixSet": { "type": "string", "example": "example string" }, "protocolRouteType": { "type": "string", "example": "ENUM_VALUE" }, "routeTag": { "$ref": "#/components/schemas/manaV2RouteTag" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourceInterface": { "type": "string", "example": "example string" }, "sourceProtocol": { "type": "string", "example": "ENUM_VALUE" }, "stalePurge": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2Vrf": { "type": "object", "properties": { "bgpAggregations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpAggregation" } }, "bgpMultipath": { "$ref": "#/components/schemas/manaV2BgpMultipath" }, "bgpNeighbors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BgpNeighbor" } }, "bgpRedistributions": { "$ref": "#/components/schemas/manaV2BgpRedistribute" }, "description": { "type": "string", "example": "example string" }, "dhcpSubnets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpServerPool" } }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "function": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipfixExporters": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpfixExporter" } }, "name": { "type": "string", "example": "example string" }, "natRuleset": { "type": "string", "example": "example string" }, "networks": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ospfv2Process": { "$ref": "#/components/schemas/manaV2OspFv2Process" }, "ospfv3Process": { "$ref": "#/components/schemas/manaV2OspFv3Process" }, "overlayFilters": { "$ref": "#/components/schemas/manaV2OverlayFilters" }, "routable": { "type": "boolean", "example": true }, "routeDistinguisher": { "type": "string", "example": "example string" }, "staticRoutes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2StaticRoute" } }, "syslogTargets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SyslogCollector" } }, "trafficRuleset": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DhcpServerPool": { "type": "object", "properties": { "defaultLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "description": { "type": "string", "example": "example string" }, "domainName": { "type": "string", "example": "example string" }, "gateway": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interface": { "type": "string", "example": "example string" }, "ipPrefix": { "type": "string", "example": "example string" }, "ipVersion": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "leases": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpLease" } }, "maxLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "minLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "nameservers": { "$ref": "#/components/schemas/manaV2DnsServers" }, "ranges": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpServerIpRange" } }, "staticLeases": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpStaticLease" } }, "totalAddresses": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "utilization": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2DhcpLease": { "type": "object", "properties": { "endsAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipAddress": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" }, "vrf": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DnsServers": { "type": "object", "properties": { "primary": { "type": "string", "example": "example string" }, "secondary": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DhcpServerIpRange": { "type": "object", "properties": { "end": { "type": "string", "example": "example string" }, "start": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DhcpStaticLease": { "type": "object", "properties": { "hostname": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipAddress": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" }, "vrf": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2OspFv2Process": { "type": "object", "properties": { "adminDistance": { "type": "integer", "format": "int32", "example": 100, "minimum": 0, "description": "Administrative Distance for routes installed" }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2OspfArea" } }, "autoRouterId": { "type": "boolean", "example": true }, "defaultOriginate": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "redistributedProtocols": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2OspfRedistribute" } }, "routerId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2OspfArea": { "type": "object", "properties": { "areaId": { "type": "string", "example": "example string" }, "bfd": { "$ref": "#/components/schemas/manaV2BfdInstance" }, "bfdNeighbors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BfdNeighbor" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2OspfInterface" } }, "name": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2OspfInterface": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/manaV2OspfAuthentication" }, "bfd": { "$ref": "#/components/schemas/manaV2BfdInstance" }, "bfdNeighbors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BfdNeighbor" } }, "cost": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "deadInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "deadIntervalValue": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "drPriority": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "helloInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "helloIntervalValue": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ifIndex": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "interface": { "type": "string", "example": "example string" }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "mtuIgnore": { "type": "boolean", "example": true }, "prefixSid": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "retransmitInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "retransmitIntervalValue": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2OspfAuthentication": { "type": "object", "properties": { "key": { "type": "string", "example": "example string", "description": "Shared secret for OSPFv2 MD5 authentication on this interface" }, "keyId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Identifier of the OSPFv2 MD5 authentication key configured on this interface" } }, "additionalProperties": false }, "manaV2OspfRedistribute": { "type": "object", "properties": { "metric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "metricType": { "type": "string", "example": "ENUM_VALUE" }, "redistType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2OspFv3Process": { "type": "object", "properties": { "adminDistance": { "type": "integer", "format": "int32", "example": 100, "minimum": 0, "description": "Administrative Distance for routes installed" }, "areas": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2OspfArea" } }, "defaultOriginate": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "redistributedProtocols": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2OspfRedistribute" } }, "routerId": { "type": "string", "example": "example string" }, "version": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2OverlayFilters": { "type": "object", "properties": { "inboundFilter": { "type": "string", "example": "example string" }, "outboundFilter": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SyslogCollector": { "type": "object", "properties": { "destinationHost": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "enabled": { "type": "boolean", "example": true }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "severity": { "type": "string", "example": "ENUM_VALUE" }, "sourceInterface": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "transport": { "type": "string", "example": "ENUM_VALUE" }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2Site": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteDeviceStub" } }, "edgeCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "location": { "$ref": "#/components/schemas/manaV2Location" }, "name": { "type": "string", "example": "example string" }, "notes": { "type": "string", "example": "example string" }, "policyReferenceCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "policyTag": { "$ref": "#/components/schemas/manaV2SingleRouteTag" }, "segmentCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "siteListReferenceCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tags": { "type": "array", "items": { "type": "string", "example": "example string" } }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "manaV2SiteDeviceStub": { "type": "object", "properties": { "hostname": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2SingleRouteTag": { "type": "object", "properties": { "levelOne": { "$ref": "#/components/schemas/manaV2SingleRouteTagRouteTagElement" }, "levelTwo": { "$ref": "#/components/schemas/manaV2SingleRouteTagRouteTagElement" }, "levelZero": { "$ref": "#/components/schemas/manaV2SingleRouteTagRouteTagElement" } }, "additionalProperties": false }, "manaV2SingleRouteTagRouteTagElement": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "tag": { "type": "string", "example": "example string" }, "tagValue": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2SlaConformance": { "type": "object", "properties": { "dampeningFactor": { "type": "integer", "format": "int64", "example": 1234567891011 }, "duration": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interval": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2Snmp": { "type": "object", "properties": { "communities": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpCommunity" } }, "engineEnableAuthenTraps": { "type": "boolean", "example": true }, "engineEnableHighMemoryTraps": { "type": "boolean", "example": true }, "engineEnableHighCpuTraps": { "type": "boolean", "example": true }, "engineEnableLocalAcessV4": { "type": "boolean", "example": true }, "engineEnableLocalAcessV6": { "type": "boolean", "example": true }, "engineEnableUserHints": { "type": "boolean", "example": true }, "engineEnableUserValidation": { "type": "boolean", "example": true }, "engineEnabled": { "type": "boolean", "example": true }, "engineEndpoints": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpEngineEndpoint" } }, "engineIdAdminOctets": { "type": "string", "example": "example string" }, "engineIdAdminText": { "type": "string", "example": "example string" }, "engineIdIpv4": { "type": "string", "example": "example string" }, "engineIdIpv6": { "type": "string", "example": "example string" }, "engineIdMac": { "type": "string", "example": "example string" }, "engineIdRaw": { "type": "string", "example": "example string" }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "notifyFilterProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpNotifyFilterProfile" } }, "snmpVersion": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "targets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpTarget" } }, "usmLocalUsers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpUsmLocalUser" } }, "usmRemoteUsers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpUsmRemoteUser" } }, "v2cEnabled": { "type": "boolean", "example": true }, "v3Enabled": { "type": "boolean", "example": true }, "vacmGroups": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpVacmGroup" } } }, "additionalProperties": false }, "manaV2SnmpCommunity": { "type": "object", "properties": { "communityString": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2SnmpEngineEndpoint": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "example": "example string" } }, "autoIpv4": { "type": "boolean", "example": true }, "autoIpv6": { "type": "boolean", "example": true }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaceName": { "type": "string", "example": "example string" }, "lanSegment": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpNotifyFilterProfile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "includeExcludeList": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NotifyFilterProfileInclude" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NotifyFilterProfileInclude": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "include": { "type": "boolean", "example": true }, "subtree": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpTarget": { "type": "object", "properties": { "community": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "notifyFilterProfile": { "type": "string", "example": "example string" }, "notifyType": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "targetIp": { "type": "string", "example": "example string" }, "targetType": { "type": "string", "example": "ENUM_VALUE" }, "usmSecurityLevel": { "type": "string", "example": "ENUM_VALUE" }, "usmUserName": { "type": "string", "example": "example string" }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpUsmLocalUser": { "type": "object", "properties": { "authPassphrase": { "type": "string", "example": "example string" }, "authProtocol": { "type": "string", "example": "ENUM_VALUE" }, "encryptionPassphrase": { "type": "string", "example": "example string" }, "encryptionProtocol": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpUsmRemoteUser": { "type": "object", "properties": { "authLocKey": { "type": "string", "example": "example string" }, "authProtocol": { "type": "string", "example": "ENUM_VALUE" }, "encryptionLocKey": { "type": "string", "example": "example string" }, "encryptionProtocol": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpVacmGroup": { "type": "object", "properties": { "accesses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpVacmGroupAccess" } }, "groupMembers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpVacmGroupMember" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "views": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpVacmView" } } }, "additionalProperties": false }, "manaV2SnmpVacmGroupAccess": { "type": "object", "properties": { "context": { "type": "string", "example": "example string" }, "groupContextMatch": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "readView": { "type": "string", "example": "example string" }, "securityLevel": { "type": "string", "example": "ENUM_VALUE" }, "writeView": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpVacmGroupMember": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "securityModel": { "type": "string", "example": "ENUM_VALUE" }, "securityName": { "type": "string", "example": "example string" }, "snmpCommunity": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2SnmpVacmView": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "includeExclude": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SnmpVacmViewInclude" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpVacmViewInclude": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "include": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2ForwardingPolicy": { "type": "object", "properties": { "dpiApplications": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DpiCustomApplication" } }, "networkLists": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpNetworkList" } }, "portLists": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2L4PortList" } }, "securityRulesets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRuleset" } }, "trafficRulesets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2TrafficPolicyRuleset" } }, "zoneFirewalls": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ZoneFirewallPolicy" } }, "zonePairs": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityZone" } } }, "additionalProperties": false }, "manaV2DpiCustomApplication": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "destinationNetwork": { "type": "string", "example": "example string" }, "destinationNetworkList": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "destinationPortList": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipProtocol": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "sourceNetwork": { "type": "string", "example": "example string" }, "sourceNetworkList": { "type": "string", "example": "example string" }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePortList": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2IpNetworkList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "networks": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2L4PortList": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "ports": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } } }, "additionalProperties": false }, "manaV2SecurityPolicyRuleset": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRulesetRule" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2SecurityPolicyRulesetRule": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "description": { "type": "string", "example": "example string" }, "downlinkBurstRate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "downlinkPolicerRate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "logging": { "type": "boolean", "example": true }, "match": { "$ref": "#/components/schemas/manaV2ForwardingPolicyMatch" }, "name": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "uplinkBurstRate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "uplinkPolicerRate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2ForwardingPolicyMatch": { "type": "object", "properties": { "application": { "type": "string", "example": "example string" }, "destinationNetwork": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "destinationPortRange": { "$ref": "#/components/schemas/manaV2PortRange" }, "domainCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "domainWildcards": { "type": "array", "items": { "type": "string", "example": "example string" } }, "dscp": { "$ref": "#/components/schemas/manaV2Dscp" }, "icmpType": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ipProtocol": { "type": "string", "example": "ENUM_VALUE" }, "protocol": { "type": "string", "example": "ENUM_VALUE" }, "sourceNetwork": { "type": "string", "example": "example string" }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePortRange": { "$ref": "#/components/schemas/manaV2PortRange" } }, "additionalProperties": false }, "manaV2PortRange": { "type": "object", "properties": { "lower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "upper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2Dscp": { "type": "object", "properties": { "codePoint": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2TrafficPolicyRuleset": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "errorMessage": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetRule" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetRule": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetRuleAction" }, "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "match": { "$ref": "#/components/schemas/manaV2ForwardingPolicyMatch" }, "name": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetRuleAction": { "type": "object", "properties": { "backupCircuit": { "type": "string", "example": "example string" }, "backupCircuitLabel": { "type": "string", "example": "example string" }, "egress": { "type": "string", "example": "ENUM_VALUE" }, "logging": { "type": "boolean", "example": true }, "primaryCircuit": { "type": "string", "example": "example string" }, "primaryCircuitLabel": { "type": "string", "example": "example string" }, "remark": { "$ref": "#/components/schemas/manaV2Dscp" }, "slaClass": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2ZoneFirewallPolicy": { "type": "object", "properties": { "ip": { "$ref": "#/components/schemas/manaV2IpFirewallPolicy" }, "udp": { "$ref": "#/components/schemas/manaV2UdpFlowTable" }, "zoneName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2IpFirewallPolicy": { "type": "object", "properties": { "blockLandAttacks": { "type": "boolean", "example": true }, "sessionLimit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "urpf": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2UdpFlowTable": { "type": "object", "properties": { "expiry": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "unidirectionalFlowLimit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2SecurityZone": { "type": "object", "properties": { "inside": { "type": "string", "example": "example string" }, "outside": { "type": "string", "example": "example string" }, "ruleset": { "type": "string", "example": "example string" }, "tcpProtection": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1DevicesSummaryGetResponse": { "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesSummaryGetResponseSiteSummary" } } }, "additionalProperties": false }, "v1DevicesSummaryGetResponseSiteSummary": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesSummaryGetResponseSiteSummaryDeviceSummary" } }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesSummaryGetResponseSiteSummaryDeviceSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isVirtual": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "overrideRegion": { "$ref": "#/components/schemas/manaV2Region" }, "platformName": { "type": "string", "example": "example string" }, "region": { "$ref": "#/components/schemas/manaV2Region" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DevicesDeviceIdGetResponse": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/manaV2Device" } }, "additionalProperties": false }, "v1DevicesDeviceIdConfigPutRequest": { "type": "object", "properties": { "configurationMetadata": { "$ref": "#/components/schemas/manaV2ConfigurationMetadata" }, "core": { "$ref": "#/components/schemas/manaV2CoreDeviceConfig" }, "description": { "type": "string", "example": "example string" }, "edge": { "$ref": "#/components/schemas/manaV2EdgeDeviceConfig" }, "localWebServerPassword": { "type": "string", "example": "example string" }, "replace": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2ConfigurationMetadata": { "type": "object", "properties": { "commitConfirm": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2CoreDeviceConfig": { "type": "object", "properties": { "bgpInstance": { "$ref": "#/components/schemas/manaV2BgpInstanceConfig" }, "coreVrf": { "$ref": "#/components/schemas/manaV2VrfConfig" }, "interfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableInterfaceCoreConfig" } }, "ipfixExporters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIpfixExporterConfig" } }, "ispVrfs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2VrfConfig" } }, "maintenanceMode": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "prefixSets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrefixSetConfig" } }, "prometheus": { "$ref": "#/components/schemas/manaV2PrometheusConfig" }, "region": { "type": "string", "example": "ENUM_VALUE" }, "regionName": { "type": "string", "example": "example string" }, "routePolicies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableRoutingPolicyConfig" } }, "site": { "$ref": "#/components/schemas/manaV2NewSite" }, "trafficPolicy": { "$ref": "#/components/schemas/manaV2ForwardingPolicyConfig" }, "vrfs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2VrfConfig" } } }, "additionalProperties": false }, "manaV2BgpInstanceConfig": { "type": "object", "properties": { "addressFamilies": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "asn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "routeServer": { "type": "boolean", "example": true }, "routerId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2VrfConfig": { "type": "object", "properties": { "bgpAggregations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpAggregationsConfig" } }, "bgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpNeighborConfig" } }, "bgpRedistribution": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpRedistributeProtocolConfig" } }, "dhcpSubnets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableDhcpSubnetConfig" } }, "ebgpMultipath": { "$ref": "#/components/schemas/manaV2NullableBgpMultipathConfig" }, "ipfixExporters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIpfixExporterConfig" } }, "natRuleset": { "$ref": "#/components/schemas/manaV2NullableNatPolicyRulesetName" }, "networks": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ospfv2": { "$ref": "#/components/schemas/manaV2NullableOspfProcessConfig" }, "ospfv3": { "$ref": "#/components/schemas/manaV2NullableOspfProcessConfig" }, "overlayFilters": { "$ref": "#/components/schemas/manaV2OverlayFilterConfig" }, "staticRoutes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableStaticRouteConfig" } }, "syslogTargets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSyslogCollectorConfig" } }, "trafficRuleset": { "$ref": "#/components/schemas/manaV2NullableTrafficPolicyRulesetName" } }, "additionalProperties": false }, "manaV2NullableBgpAggregationsConfig": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2BgpAggregationsConfig" } }, "additionalProperties": false }, "manaV2BgpAggregationsConfig": { "type": "object", "properties": { "asSet": { "type": "boolean", "example": true }, "prefix": { "type": "string", "example": "example string" }, "summaryOnly": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NullableBgpNeighborConfig": { "type": "object", "properties": { "neighbor": { "$ref": "#/components/schemas/manaV2BgpNeighborConfig" } }, "additionalProperties": false }, "manaV2BgpNeighborConfig": { "type": "object", "properties": { "addressFamilies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpNeighborAddressFamilyConfig" } }, "allowAsIn": { "$ref": "#/components/schemas/manaV2NullableAllowAsIn" }, "asOverride": { "type": "boolean", "example": true }, "bfd": { "$ref": "#/components/schemas/manaV2NullableBfdInstanceConfig" }, "defaultOriginate": { "type": "string", "example": "ENUM_VALUE" }, "ebgpMultihopTtl": { "$ref": "#/components/schemas/manaV2NullableEbgpConfig" }, "enabled": { "type": "boolean", "example": true }, "holdTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "holdTimerValue": { "$ref": "#/components/schemas/manaV2NullableHoldTimer" }, "keepaliveTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "keepaliveTimerValue": { "$ref": "#/components/schemas/manaV2NullableKeepAliveTimer" }, "localAddress": { "type": "string", "example": "example string" }, "localInterface": { "$ref": "#/components/schemas/manaV2NullableInterfaceName" }, "maxPrefixValue": { "$ref": "#/components/schemas/manaV2NullableMaxPrefix" }, "md5Password": { "$ref": "#/components/schemas/manaV2NullableMd5Password" }, "peerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "remoteAddress": { "type": "string", "example": "example string" }, "removePrivateAs": { "type": "boolean", "example": true }, "sendCommunity": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NullableBgpNeighborAddressFamilyConfig": { "type": "object", "properties": { "family": { "$ref": "#/components/schemas/manaV2BgpNeighborAddressFamilyConfig" } }, "additionalProperties": false }, "manaV2BgpNeighborAddressFamilyConfig": { "type": "object", "properties": { "addressFamily": { "type": "string", "example": "ENUM_VALUE" }, "inboundPolicy": { "$ref": "#/components/schemas/manaV2NullablePolicyName" }, "outboundPolicy": { "$ref": "#/components/schemas/manaV2NullablePolicyName" } }, "additionalProperties": false }, "manaV2NullablePolicyName": { "type": "object", "properties": { "policy": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableAllowAsIn": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableBfdInstanceConfig": { "type": "object", "properties": { "bfd": { "$ref": "#/components/schemas/manaV2BfdInstanceConfig" } }, "additionalProperties": false }, "manaV2BfdInstanceConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "localMultiplier": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "minimumInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableEbgpConfig": { "type": "object", "properties": { "multiHop": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableHoldTimer": { "type": "object", "properties": { "timer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableKeepAliveTimer": { "type": "object", "properties": { "timer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableInterfaceName": { "type": "object", "properties": { "interface": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableMaxPrefix": { "type": "object", "properties": { "maxPrefix": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableMd5Password": { "type": "object", "properties": { "md5Password": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableBgpRedistributeProtocolConfig": { "type": "object", "properties": { "protocol": { "$ref": "#/components/schemas/manaV2BgpRedistributeProtocolConfig" } }, "additionalProperties": false }, "manaV2BgpRedistributeProtocolConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NullableDhcpSubnetConfig": { "type": "object", "properties": { "subnet": { "$ref": "#/components/schemas/manaV2DhcpSubnetConfig" } }, "additionalProperties": false }, "manaV2DhcpSubnetConfig": { "type": "object", "properties": { "defaultLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "description": { "type": "string", "example": "example string" }, "domainName": { "type": "string", "example": "example string" }, "domainNameServer": { "$ref": "#/components/schemas/manaV2DhcpServerDnsParametersConfig" }, "interface": { "type": "string", "example": "example string" }, "ipGateway": { "type": "string", "example": "example string" }, "ipPrefix": { "type": "string", "example": "example string" }, "ipRanges": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpipRangeConfig" } }, "ipRangesV2": { "$ref": "#/components/schemas/manaV2NullableDhcpipRangeList" }, "maxLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "minLeaseTimeSecs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "staticLeases": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableDhcpSubnetStaticLeaseConfig" } } }, "additionalProperties": false }, "manaV2DhcpServerDnsParametersConfig": { "type": "object", "properties": { "primary": { "type": "string", "example": "example string" }, "secondary": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DhcpipRangeConfig": { "type": "object", "properties": { "end": { "type": "string", "example": "example string" }, "start": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableDhcpipRangeList": { "type": "object", "properties": { "ipRange": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpipRangeConfig" } } }, "additionalProperties": false }, "manaV2NullableDhcpSubnetStaticLeaseConfig": { "type": "object", "properties": { "lease": { "$ref": "#/components/schemas/manaV2DhcpSubnetStaticLeaseConfig" } }, "additionalProperties": false }, "manaV2DhcpSubnetStaticLeaseConfig": { "type": "object", "properties": { "hostname": { "type": "string", "example": "example string" }, "ipAddress": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableBgpMultipathConfig": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2BgpMultipathConfig" } }, "additionalProperties": false }, "manaV2BgpMultipathConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableIpfixExporterConfig": { "type": "object", "properties": { "exporter": { "$ref": "#/components/schemas/manaV2IpfixExporterConfig" } }, "additionalProperties": false }, "manaV2IpfixExporterConfig": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "monitoredSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "name": { "type": "string", "example": "example string" }, "sampleMode": { "type": "string", "example": "ENUM_VALUE" }, "sampleRate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourceInterfaceName": { "type": "string", "example": "example string" }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableNatPolicyRulesetName": { "type": "object", "properties": { "ruleset": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableOspfProcessConfig": { "type": "object", "properties": { "process": { "$ref": "#/components/schemas/manaV2OspfProcessConfig" } }, "additionalProperties": false }, "manaV2OspfProcessConfig": { "type": "object", "properties": { "addressFamilies": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "adminDistance": { "$ref": "#/components/schemas/manaV2NullableOspfAdminDistanceValue" }, "areas": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableOspfAreaConfig" } }, "auto": { "type": "boolean", "example": true }, "defaultOriginate": { "type": "string", "example": "ENUM_VALUE" }, "manual": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "redistribution": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableOspfRedistributeProtocolConfig" } } }, "additionalProperties": false }, "manaV2NullableOspfAdminDistanceValue": { "type": "object", "properties": { "adminDistance": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableOspfAreaConfig": { "type": "object", "properties": { "area": { "$ref": "#/components/schemas/manaV2OspfAreaConfig" } }, "additionalProperties": false }, "manaV2OspfAreaConfig": { "type": "object", "properties": { "areaId": { "type": "string", "example": "example string" }, "interfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableOspfInterfaceConfig" } }, "name": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableOspfInterfaceConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2OspfInterfaceConfig" } }, "additionalProperties": false }, "manaV2OspfInterfaceConfig": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/manaV2NullableOspfAuthenticationConfig" }, "bfd": { "$ref": "#/components/schemas/manaV2NullableBfdInstanceConfig" }, "cost": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "deadIntervalValue": { "$ref": "#/components/schemas/manaV2NullableOspfDeadIntervalValue" }, "drPriority": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "helloIntervalValue": { "$ref": "#/components/schemas/manaV2NullableOspfHelloIntervalValue" }, "interfaceName": { "type": "string", "example": "example string" }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "mtuIgnore": { "type": "boolean", "example": true }, "prefixSid": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "retransmitIntervalValue": { "$ref": "#/components/schemas/manaV2NullableOspfRetransmitIntervalValue" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableOspfAuthenticationConfig": { "type": "object", "properties": { "authentication": { "$ref": "#/components/schemas/manaV2OspfAuthenticationConfig" } }, "additionalProperties": false }, "manaV2OspfAuthenticationConfig": { "type": "object", "properties": {}, "additionalProperties": false }, "manaV2NullableOspfDeadIntervalValue": { "type": "object", "properties": { "deadInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableOspfHelloIntervalValue": { "type": "object", "properties": { "helloInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableOspfRetransmitIntervalValue": { "type": "object", "properties": { "retransmitInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableOspfRedistributeProtocolConfig": { "type": "object", "properties": { "protocol": { "$ref": "#/components/schemas/manaV2OspfRedistributeProtocolConfig" } }, "additionalProperties": false }, "manaV2OspfRedistributeProtocolConfig": { "type": "object", "properties": { "metric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "metricType": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2OverlayFilterConfig": { "type": "object", "properties": { "exportPolicy": { "$ref": "#/components/schemas/manaV2NullablePolicyName" }, "importPolicy": { "$ref": "#/components/schemas/manaV2NullablePolicyName" } }, "additionalProperties": false }, "manaV2NullableStaticRouteConfig": { "type": "object", "properties": { "route": { "$ref": "#/components/schemas/manaV2StaticRouteConfig" } }, "additionalProperties": false }, "manaV2StaticRouteConfig": { "type": "object", "properties": { "adminDistance": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "administrativeDistance": { "$ref": "#/components/schemas/manaV2NullableAdministrativeDistance" }, "description": { "type": "string", "example": "example string" }, "destinationPrefix": { "type": "string", "example": "example string" }, "ipVersion": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "nextHop": { "$ref": "#/components/schemas/manaV2StaticRouteNexthopConfig" }, "nextHops": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2StaticRouteNexthopConfig" } } }, "additionalProperties": false }, "manaV2NullableAdministrativeDistance": { "type": "object", "properties": { "distance": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2StaticRouteNexthopConfig": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "interface": { "type": "string", "example": "example string" }, "nextHopAddress": { "type": "string", "example": "example string" }, "thirdPartyIpsecTunnel": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSyslogCollectorConfig": { "type": "object", "properties": { "target": { "$ref": "#/components/schemas/manaV2SyslogCollectorConfig" } }, "additionalProperties": false }, "manaV2SyslogCollectorConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "host": { "type": "string", "example": "example string" }, "interfaceName": { "type": "string", "example": "example string" }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "port": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "severity": { "type": "string", "example": "ENUM_VALUE" }, "transport": { "type": "string", "example": "ENUM_VALUE" }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableTrafficPolicyRulesetName": { "type": "object", "properties": { "ruleset": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableInterfaceCoreConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2InterfaceCoreConfig" } }, "additionalProperties": false }, "manaV2InterfaceCoreConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "coreNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToCorePeerConfig" }, "coreToCoreTunnel": { "$ref": "#/components/schemas/manaV2InterfaceWanManagementConfig" }, "createLinkLocalAddress": { "type": "boolean", "example": true }, "default": { "$ref": "#/components/schemas/manaV2InterfaceDefaultConfig" }, "description": { "type": "string", "example": "example string" }, "duplex": { "type": "string", "example": "example string" }, "dynamic": { "$ref": "#/components/schemas/manaV2LatencyBandwidth" }, "flexAlgos": { "$ref": "#/components/schemas/manaV2InterfaceCoreFlexAlgoConfig" }, "gatewayNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToGatewayPeerConfig" }, "gw": { "$ref": "#/components/schemas/manaV2NullableInterfaceIpConfig" }, "interfaceType": { "$ref": "#/components/schemas/manaV2interface_config_type" }, "ipsec": { "$ref": "#/components/schemas/manaV2InterfaceIPsecConfig" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "lan": { "type": "string", "example": "example string" }, "lldpEnabled": { "type": "boolean", "example": true }, "loopback": { "type": "boolean", "example": true }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "mplsEnabled": { "type": "boolean", "example": true }, "ospfCost": { "$ref": "#/components/schemas/manaV2CoreLinkCost" }, "ospfInterface": { "$ref": "#/components/schemas/manaV2NullableOspfInterfaceConfig" }, "peerDeviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "peerHostname": { "type": "string", "example": "example string" }, "securityZone": { "type": "string", "example": "example string" }, "speed": { "type": "integer", "format": "int64", "example": 1234567891011 }, "static": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "subinterfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableCoreInterfaceVlanConfig" } }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnelInterface": { "type": "string", "example": "example string" }, "tunnelUnderlay": { "type": "string", "example": "example string" }, "wan": { "$ref": "#/components/schemas/manaV2InterfaceWanConfig" }, "wanManagement": { "$ref": "#/components/schemas/manaV2InterfaceWanManagementConfig" }, "xTalkFilter": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2InterfaceCoreToCorePeerConfig": { "type": "object", "properties": { "Cost": { "$ref": "#/components/schemas/manaV2CoreLinkCost" }, "ospfCost": { "$ref": "#/components/schemas/manaV2CoreLinkCost" }, "peerHostname": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2CoreLinkCost": { "type": "object", "properties": { "dynamic": { "$ref": "#/components/schemas/manaV2LatencyBandwidth" }, "static": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2LatencyBandwidth": { "type": "object", "properties": { "bandwidth": { "type": "integer", "format": "int32", "example": 123 }, "latency": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2InterfaceWanManagementConfig": { "type": "object", "properties": {}, "additionalProperties": false }, "manaV2InterfaceDefaultConfig": { "type": "object", "properties": {}, "additionalProperties": false }, "manaV2InterfaceCoreFlexAlgoConfig": { "type": "object", "properties": { "flexAlgoNames": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2InterfaceCoreToGatewayPeerConfig": { "type": "object", "properties": { "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableInterfaceIpConfig": { "type": "object", "properties": { "gw": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" } }, "additionalProperties": false }, "manaV2InterfaceIpConfig": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/manaV2NullableAddress" }, "dhcp": { "$ref": "#/components/schemas/manaV2InterfaceDhcpConfig" }, "gw": { "$ref": "#/components/schemas/manaV2NullableGatewayConfig" }, "vrrp": { "$ref": "#/components/schemas/manaV2NullableVrrpGroupConfig" } }, "additionalProperties": false }, "manaV2NullableAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2InterfaceDhcpConfig": { "type": "object", "properties": { "dhcpClient": { "type": "boolean", "example": true }, "dhcpRelay": { "$ref": "#/components/schemas/manaV2DhcpRelayConfig" } }, "additionalProperties": false }, "manaV2DhcpRelayConfig": { "type": "object", "properties": { "relayServers": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NullableGatewayConfig": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableVrrpGroupConfig": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/manaV2VrrpGroupConfig" } }, "additionalProperties": false }, "manaV2VrrpGroupConfig": { "type": "object", "properties": { "acceptMode": { "type": "boolean", "example": true }, "allowInterOperability": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "example string" }, "enabled": { "type": "boolean", "example": true }, "preempt": { "type": "boolean", "example": true }, "priority": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "trackedInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NullableInterfacePriorityDecrement" } }, "virtualIp": { "type": "string", "example": "example string" }, "virtualRouterId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableInterfacePriorityDecrement": { "type": "object", "properties": { "interface": { "type": "string", "example": "example string" }, "priorityDecrement": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2interface_config_type": { "type": "object", "properties": { "coreNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToCorePeerConfig" }, "coreToCoreTunnel": { "$ref": "#/components/schemas/manaV2InterfaceWanManagementConfig" }, "default": { "$ref": "#/components/schemas/manaV2InterfaceDefaultConfig" }, "gatewayNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToGatewayPeerConfig" }, "wan": { "$ref": "#/components/schemas/manaV2InterfaceWanConfig" }, "wanManagement": { "$ref": "#/components/schemas/manaV2InterfaceWanManagementConfig" } }, "additionalProperties": false }, "manaV2InterfaceWanConfig": { "type": "object", "properties": { "gw": { "$ref": "#/components/schemas/manaV2NullableInterfaceIpConfig" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2InterfaceIPsecConfig": { "type": "object", "properties": { "antiReplayWindowSize": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dhGroup": { "type": "string", "example": "ENUM_VALUE" }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "encryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "esn": { "type": "boolean", "example": true }, "ikeIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "initiator": { "type": "boolean", "example": true }, "ipsecEncryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "ipsecIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "label": { "type": "string", "example": "ENUM_VALUE" }, "localAddress": { "type": "string", "example": "example string" }, "localCircuit": { "type": "string", "example": "example string" }, "localIkePeerIdentity": { "type": "string", "example": "example string" }, "perfectForwardSecrecy": { "type": "string", "example": "ENUM_VALUE" }, "presharedKey": { "type": "string", "example": "example string" }, "reauthInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "rekeyInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "remoteAddress": { "type": "string", "example": "example string" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableCoreInterfaceVlanConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2CoreVlanInterfaceConfig" } }, "additionalProperties": false }, "manaV2CoreVlanInterfaceConfig": { "type": "object", "properties": { "coreNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToCorePeerConfig" }, "default": { "$ref": "#/components/schemas/manaV2InterfaceDefaultConfig" }, "gatewayNeighbor": { "$ref": "#/components/schemas/manaV2InterfaceCoreToGatewayPeerConfig" }, "interface": { "$ref": "#/components/schemas/manaV2CoreInterfaceConfig" }, "interfaceType": { "$ref": "#/components/schemas/manaV2interface_config_type" }, "vlanId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "wan": { "$ref": "#/components/schemas/manaV2InterfaceWanConfig" } }, "additionalProperties": false }, "manaV2CoreInterfaceConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "duplex": { "type": "string", "example": "example string" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "mplsEnabled": { "type": "boolean", "example": true }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "xTalkFilter": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NullablePrefixSetConfig": { "type": "object", "properties": { "prefixSet": { "$ref": "#/components/schemas/manaV2PrefixSetConfig" } }, "additionalProperties": false }, "manaV2PrefixSetConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PrefixSetConfigNullableEntry" } }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "mode": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2PrefixSetConfigNullableEntry": { "type": "object", "properties": { "entry": { "$ref": "#/components/schemas/manaV2PrefixSetConfigNullableEntryEntry" } }, "additionalProperties": false }, "manaV2PrefixSetConfigNullableEntryEntry": { "type": "object", "properties": { "ipPrefix": { "type": "string", "example": "example string" }, "maskLower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "maskUpper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2PrometheusConfig": { "type": "object", "properties": { "ruleGroups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrometheusRuleGroupConfig" } }, "sink": { "$ref": "#/components/schemas/manaV2NullablePrometheusRemoteWriteSinkConfig" }, "sysdbMonitors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrometheusSysDbMonitorConfig" } } }, "additionalProperties": false }, "manaV2NullablePrometheusRuleGroupConfig": { "type": "object", "properties": { "ruleGroup": { "$ref": "#/components/schemas/manaV2PrometheusRuleGroupConfig" } }, "additionalProperties": false }, "manaV2PrometheusRuleGroupConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "intervalSeconds": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrometheusRuleConfig" } } }, "additionalProperties": false }, "manaV2NullablePrometheusRuleConfig": { "type": "object", "properties": { "ruleGroup": { "$ref": "#/components/schemas/manaV2PrometheusRuleConfig" } }, "additionalProperties": false }, "manaV2PrometheusRuleConfig": { "type": "object", "properties": { "alert": { "type": "boolean", "example": true }, "expression": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "severity": { "type": "string", "example": "example string" }, "template": { "type": "string", "example": "example string" }, "triggerSeconds": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullablePrometheusRemoteWriteSinkConfig": { "type": "object", "properties": { "sink": { "$ref": "#/components/schemas/manaV2PrometheusRemoteWriteSinkConfig" } }, "additionalProperties": false }, "manaV2PrometheusRemoteWriteSinkConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "host": { "type": "string", "example": "example string" }, "path": { "type": "string", "example": "example string" }, "port": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullablePrometheusSysDbMonitorConfig": { "type": "object", "properties": { "sysdbMonitor": { "$ref": "#/components/schemas/manaV2PrometheusSysDbMonitorConfig" } }, "additionalProperties": false }, "manaV2PrometheusSysDbMonitorConfig": { "type": "object", "properties": { "intervalSeconds": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "xpaths": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NullableRoutingPolicyConfig": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfig" } }, "additionalProperties": false }, "manaV2RoutingPolicyConfig": { "type": "object", "properties": { "attachPoint": { "type": "string", "example": "ENUM_VALUE" }, "defaultAction": { "type": "string", "example": "ENUM_VALUE" }, "description": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "statements": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatement" } } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatement": { "type": "object", "properties": { "statement": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatementStatement" } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatementStatement": { "type": "object", "properties": { "actions": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatementStatementNullableAction" } }, "matches": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatementStatementNullableMatch" } }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatementStatementNullableAction": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatementStatementNullableActionAction" } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatementStatementNullableActionAction": { "type": "object", "properties": { "administrativeDistance": { "$ref": "#/components/schemas/manaV2NullableAdministrativeDistance" }, "aspathPrepend": { "$ref": "#/components/schemas/manaV2NullableAsPathPrepend" }, "bgpSetNextHop": { "$ref": "#/components/schemas/manaV2NullableBgpSetNextHop" }, "callPolicy": { "$ref": "#/components/schemas/manaV2NullableCallPolicy" }, "communities": { "$ref": "#/components/schemas/manaV2NullableCommunities" }, "localPref": { "$ref": "#/components/schemas/manaV2NullableLocalPreferance" }, "metric": { "$ref": "#/components/schemas/manaV2NullableMetric" }, "result": { "type": "string", "example": "ENUM_VALUE" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "weight": { "$ref": "#/components/schemas/manaV2NullableWeight" } }, "additionalProperties": false }, "manaV2NullableAsPathPrepend": { "type": "object", "properties": { "repeat": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableBgpSetNextHop": { "type": "object", "properties": { "nextHop": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableCallPolicy": { "type": "object", "properties": { "policy": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableCommunities": { "type": "object", "properties": { "community": { "$ref": "#/components/schemas/manaV2CommunityType" } }, "additionalProperties": false }, "manaV2NullableLocalPreferance": { "type": "object", "properties": { "localPref": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableMetric": { "type": "object", "properties": { "absolute": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "modifier": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2NullableWeight": { "type": "object", "properties": { "weight": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatementStatementNullableMatch": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2RoutingPolicyConfigNullableStatementStatementNullableMatchMatch" } }, "additionalProperties": false }, "manaV2RoutingPolicyConfigNullableStatementStatementNullableMatchMatch": { "type": "object", "properties": { "community": { "$ref": "#/components/schemas/manaV2NullableCommunity" }, "prefixSet": { "$ref": "#/components/schemas/manaV2NullablePrefixSet" }, "protocolRouteType": { "$ref": "#/components/schemas/manaV2NullableProtocolRouteType" }, "routeTag": { "$ref": "#/components/schemas/manaV2NullableRouteTagSet" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourceInterface": { "$ref": "#/components/schemas/manaV2NullableInterfaceName" }, "sourceProtocol": { "$ref": "#/components/schemas/manaV2NullableRoutingProtocol" }, "stale": { "$ref": "#/components/schemas/manaV2NullableStalePurge" } }, "additionalProperties": false }, "manaV2NullableCommunity": { "type": "object", "properties": { "community": { "$ref": "#/components/schemas/manaV2CommunityContainer" } }, "additionalProperties": false }, "manaV2CommunityContainer": { "type": "object", "properties": { "community": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NullablePrefixSet": { "type": "object", "properties": { "prefixSet": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableProtocolRouteType": { "type": "object", "properties": { "routeType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableRouteTagSet": { "type": "object", "properties": { "entry": { "$ref": "#/components/schemas/manaV2RouteTag" } }, "additionalProperties": false }, "manaV2NullableRoutingProtocol": { "type": "object", "properties": { "protocol": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableStalePurge": { "type": "object", "properties": { "stale": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NewSite": { "type": "object", "properties": { "globalPrefixSetOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "ipfixExporterOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "ipfixExporterOpsV2": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectOperationConfig" } }, "location": { "$ref": "#/components/schemas/manaV2Location" }, "name": { "type": "string", "example": "example string" }, "notes": { "type": "string", "example": "example string" }, "ntpOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "prefixSetOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "routeTag": { "$ref": "#/components/schemas/manaV2RouteTag" }, "routingPolicyOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "snmpOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "syslogServerOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } }, "syslogServerOpsV2": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectOperationConfig" } }, "trafficPolicyOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "manaV2GlobalObjectOperationConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2NullableSiteInterfaceName" }, "operation": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableSiteInterfaceName": { "type": "object", "properties": { "interface": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2ForwardingPolicyConfig": { "type": "object", "properties": { "dpiApplications": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableDpiApplicationConfig" } }, "networkLists": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIpNetworkListConfig" } }, "portLists": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableL4PortListConfig" } }, "securityRulesets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSecurityPolicyRulesetConfig" } }, "trafficRulesets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableTrafficPolicyRulesetConfig" } }, "zoneFirewalls": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableZoneFirewallConfig" } }, "zones": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSecurityZoneConfig" } } }, "additionalProperties": false }, "manaV2NullableDpiApplicationConfig": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/manaV2DpiApplicationConfig" } }, "additionalProperties": false }, "manaV2DpiApplicationConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "destinationNetwork": { "type": "string", "example": "example string" }, "destinationNetworkList": { "type": "string", "example": "example string" }, "destinationNetworks": { "$ref": "#/components/schemas/manaV2IpNetworkListConfig" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "destinationPortList": { "type": "string", "example": "example string" }, "destinationPorts": { "$ref": "#/components/schemas/manaV2L4PortListConfig" }, "icmpType": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ipProtocol": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "sourceNetwork": { "type": "string", "example": "example string" }, "sourceNetworkList": { "type": "string", "example": "example string" }, "sourceNetworks": { "$ref": "#/components/schemas/manaV2IpNetworkListConfig" }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePortList": { "type": "string", "example": "example string" }, "sourcePorts": { "$ref": "#/components/schemas/manaV2L4PortListConfig" } }, "additionalProperties": false }, "manaV2IpNetworkListConfig": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "networks": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2L4PortListConfig": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "ports": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } } }, "additionalProperties": false }, "manaV2NullableIpNetworkListConfig": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/manaV2IpNetworkListConfig" } }, "additionalProperties": false }, "manaV2NullableL4PortListConfig": { "type": "object", "properties": { "list": { "$ref": "#/components/schemas/manaV2L4PortListConfig" } }, "additionalProperties": false }, "manaV2NullableSecurityPolicyRulesetConfig": { "type": "object", "properties": { "ruleset": { "$ref": "#/components/schemas/manaV2SecurityPolicyRulesetConfig" } }, "additionalProperties": false }, "manaV2SecurityPolicyRulesetConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2SecurityPolicyRulesetConfigNullableRule" } } }, "additionalProperties": false }, "manaV2SecurityPolicyRulesetConfigNullableRule": { "type": "object", "properties": { "rule": { "$ref": "#/components/schemas/manaV2SecurityPolicyRulesetConfigNullableRuleRule" } }, "additionalProperties": false }, "manaV2SecurityPolicyRulesetConfigNullableRuleRule": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "description": { "type": "string", "example": "example string" }, "downlinkBurstRate": { "$ref": "#/components/schemas/manaV2NullableMeterRates" }, "downlinkPolicerRate": { "$ref": "#/components/schemas/manaV2NullableMeterRates" }, "logging": { "type": "boolean", "example": true }, "match": { "$ref": "#/components/schemas/manaV2ForwardingPolicyMatchConfig" }, "name": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "uplinkBurstRate": { "$ref": "#/components/schemas/manaV2NullableMeterRates" }, "uplinkPolicerRate": { "$ref": "#/components/schemas/manaV2NullableMeterRates" } }, "additionalProperties": false }, "manaV2NullableMeterRates": { "type": "object", "properties": { "rate": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2ForwardingPolicyMatchConfig": { "type": "object", "properties": { "application": { "$ref": "#/components/schemas/manaV2NullableApplicationMatchConfig" }, "contentFilter": { "$ref": "#/components/schemas/manaV2NullableContentFilterMatchConfig" }, "destinationNetwork": { "$ref": "#/components/schemas/manaV2NullableDestinationNetworkMatchConfig" }, "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "destinationPortRange": { "$ref": "#/components/schemas/manaV2PortRangeConfig" }, "domainList": { "$ref": "#/components/schemas/manaV2NullableDomainListMatchConfig" }, "dscp": { "$ref": "#/components/schemas/manaV2NullableDscpMatchConfig" }, "icmpType": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ipProtocol": { "type": "string", "example": "ENUM_VALUE" }, "protocol": { "$ref": "#/components/schemas/manaV2NullableIpProtocol" }, "sourceNetwork": { "$ref": "#/components/schemas/manaV2NullableSourceNetworkMatchConfig" }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePortRange": { "$ref": "#/components/schemas/manaV2PortRangeConfig" } }, "additionalProperties": false }, "manaV2NullableApplicationMatchConfig": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2ApplicationMatchConfig" } }, "additionalProperties": false }, "manaV2ApplicationMatchConfig": { "type": "object", "properties": { "builtin": { "type": "string", "example": "example string" }, "custom": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableContentFilterMatchConfig": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2ContentFilterMatchConfig" } }, "additionalProperties": false }, "manaV2ContentFilterMatchConfig": { "type": "object", "properties": { "domainCategoryIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "manaV2NullableDestinationNetworkMatchConfig": { "type": "object", "properties": { "destinationNetwork": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2PortRangeConfig": { "type": "object", "properties": { "lower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "upper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableDomainListMatchConfig": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2DomainListMatchConfig" } }, "additionalProperties": false }, "manaV2DomainListMatchConfig": { "type": "object", "properties": { "domainWildcards": { "type": "array", "items": { "type": "string", "example": "example string", "description": "List of wildcard strings each representing a selection of domains to apply the policy action on" } } }, "additionalProperties": false }, "manaV2NullableDscpMatchConfig": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2Dscp" } }, "additionalProperties": false }, "manaV2NullableIpProtocol": { "type": "object", "properties": { "ipProtocol": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableSourceNetworkMatchConfig": { "type": "object", "properties": { "sourceNetwork": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableTrafficPolicyRulesetConfig": { "type": "object", "properties": { "ruleset": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetConfig" } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetConfigNullableRule" } } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetConfigNullableRule": { "type": "object", "properties": { "rule": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetConfigNullableRuleRule" } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetConfigNullableRuleRule": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/manaV2TrafficPolicyRulesetConfigNullableRuleRuleAction" }, "description": { "type": "string", "example": "example string" }, "match": { "$ref": "#/components/schemas/manaV2ForwardingPolicyMatchConfig" }, "name": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2TrafficPolicyRulesetConfigNullableRuleRuleAction": { "type": "object", "properties": { "backupCircuit": { "$ref": "#/components/schemas/manaV2NullableSetCircuitConfig" }, "backupCircuitLabel": { "$ref": "#/components/schemas/manaV2NullableSetCircuitLabelConfig" }, "egress": { "type": "string", "example": "ENUM_VALUE" }, "logging": { "type": "boolean", "example": true }, "primaryCircuit": { "$ref": "#/components/schemas/manaV2NullableSetCircuitConfig" }, "primaryCircuitLabel": { "$ref": "#/components/schemas/manaV2NullableSetCircuitLabelConfig" }, "remark": { "$ref": "#/components/schemas/manaV2NullableSetDscpConfig" }, "setSlaClass": { "$ref": "#/components/schemas/manaV2NullableSetSlaClassConfig" } }, "additionalProperties": false }, "manaV2NullableSetCircuitConfig": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSetCircuitLabelConfig": { "type": "object", "properties": { "ipsecLabel": { "type": "string", "example": "ENUM_VALUE" }, "label": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableSetDscpConfig": { "type": "object", "properties": { "val": { "$ref": "#/components/schemas/manaV2Dscp" } }, "additionalProperties": false }, "manaV2NullableSetSlaClassConfig": { "type": "object", "properties": { "class": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableZoneFirewallConfig": { "type": "object", "properties": { "zoneFirewall": { "$ref": "#/components/schemas/manaV2ZoneFirewallConfig" } }, "additionalProperties": false }, "manaV2ZoneFirewallConfig": { "type": "object", "properties": { "ip": { "$ref": "#/components/schemas/manaV2ZoneFirewallIpPolicyConfig" }, "udp": { "$ref": "#/components/schemas/manaV2ZoneFirewallUdpPolicyConfig" } }, "additionalProperties": false }, "manaV2ZoneFirewallIpPolicyConfig": { "type": "object", "properties": { "blockLandAttacks": { "type": "boolean", "example": true }, "sessionLimit": { "$ref": "#/components/schemas/manaV2NullableSessionLimit" }, "urpf": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableSessionLimit": { "type": "object", "properties": { "limit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2ZoneFirewallUdpPolicyConfig": { "type": "object", "properties": { "unidirectionalFlowLimit": { "$ref": "#/components/schemas/manaV2NullableSessionLimit" } }, "additionalProperties": false }, "manaV2NullableSecurityZoneConfig": { "type": "object", "properties": { "zone": { "$ref": "#/components/schemas/manaV2SecurityZoneConfig" } }, "additionalProperties": false }, "manaV2SecurityZoneConfig": { "type": "object", "properties": { "inside": { "type": "string", "example": "example string" }, "pairs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSecurityZonePairConfig" } } }, "additionalProperties": false }, "manaV2NullableSecurityZonePairConfig": { "type": "object", "properties": { "pair": { "$ref": "#/components/schemas/manaV2SecurityZonePairConfig" } }, "additionalProperties": false }, "manaV2SecurityZonePairConfig": { "type": "object", "properties": { "outside": { "type": "string", "example": "example string" }, "ruleset": { "type": "string", "example": "example string" }, "tcpProtection": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2EdgeDeviceConfig": { "type": "object", "properties": { "bgpEnabled": { "type": "boolean", "example": true }, "bgpInstance": { "$ref": "#/components/schemas/manaV2BgpInstanceConfig" }, "circuits": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2CircuitConfig" } }, "dhcpServerEnabled": { "type": "boolean", "example": true }, "dns": { "$ref": "#/components/schemas/manaV2NullableDnsConfig" }, "interfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableInterfaceConfig" } }, "ipfixEnabled": { "type": "boolean", "example": true }, "ipfixExporters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIpfixExporterConfig" } }, "lagInterfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableLagInterfaceConfig" } }, "lldpEnabled": { "type": "boolean", "example": true }, "localRouteTag": { "$ref": "#/components/schemas/manaV2NullableRouteTagSet" }, "localWebServerPassword": { "type": "string", "example": "example string" }, "location": { "$ref": "#/components/schemas/manaV2Location" }, "maintenanceMode": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "natPolicy": { "$ref": "#/components/schemas/manaV2NatPolicyConfig" }, "ntpGlobalObject": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableNtpConfig" } }, "ospfv2Enabled": { "type": "boolean", "example": true }, "ospfv3Enabled": { "type": "boolean", "example": true }, "prefixSets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrefixSetConfig" } }, "region": { "type": "string", "example": "ENUM_VALUE" }, "regionName": { "type": "string", "example": "example string" }, "routePolicies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableRoutingPolicyConfig" } }, "segments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2VrfConfig" } }, "site": { "$ref": "#/components/schemas/manaV2NewSite" }, "siteToSiteVpn": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIPsecTunnelConfig" } }, "slaConformance": { "$ref": "#/components/schemas/manaV2NullableSlaConformance" }, "snmp": { "$ref": "#/components/schemas/manaV2NullableSnmpConfig" }, "snmpGlobalObject": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpConfig" } }, "staticRoutesEnabled": { "type": "boolean", "example": true }, "trafficPolicy": { "$ref": "#/components/schemas/manaV2ForwardingPolicyConfig" }, "vrrpEnabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2CircuitConfig": { "type": "object", "properties": { "bgpAggregations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpAggregationsConfig" } }, "bgpMultipath": { "$ref": "#/components/schemas/manaV2NullableBgpMultipathConfig" }, "bgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpNeighborConfig" } }, "bgpRedistribution": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpRedistributeProtocolConfig" } }, "carrier": { "type": "string", "example": "ENUM_VALUE" }, "circuitType": { "type": "string", "example": "ENUM_VALUE" }, "connectionType": { "type": "string", "example": "ENUM_VALUE" }, "description": { "type": "string", "example": "example string" }, "diaEnabled": { "type": "boolean", "example": true }, "dropMechanism": { "type": "string", "example": "ENUM_VALUE" }, "label": { "type": "string", "example": "ENUM_VALUE" }, "lastResort": { "type": "boolean", "example": true }, "linkDownSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "linkUpSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "loopback": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "patAddresses": { "$ref": "#/components/schemas/manaV2NullableIpList" }, "qosProfile": { "type": "string", "example": "ENUM_VALUE" }, "qosProfileType": { "type": "string", "example": "ENUM_VALUE" }, "staticRoutes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableStaticRouteConfig" } } }, "additionalProperties": false }, "manaV2NullableIpList": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NullableDnsConfig": { "type": "object", "properties": { "dns": { "$ref": "#/components/schemas/manaV2DnsConfig" } }, "additionalProperties": false }, "manaV2DnsConfig": { "type": "object", "properties": { "cloudflare": { "$ref": "#/components/schemas/manaV2DNSConfigCloudflare" }, "dynamic": { "$ref": "#/components/schemas/manaV2DNSConfigDynamic" }, "static": { "$ref": "#/components/schemas/manaV2DNSConfigStatic" } }, "additionalProperties": false }, "manaV2DNSConfigCloudflare": { "type": "object", "properties": {}, "additionalProperties": false }, "manaV2DNSConfigDynamic": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "interfaceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DNSConfigStatic": { "type": "object", "properties": { "primaryIpv4V2": { "$ref": "#/components/schemas/manaV2NullableIPv4Address" }, "primaryIpv6V2": { "$ref": "#/components/schemas/manaV2NullableIPv6Address" }, "secondaryIpv4V2": { "$ref": "#/components/schemas/manaV2NullableIPv4Address" }, "secondaryIpv6V2": { "$ref": "#/components/schemas/manaV2NullableIPv6Address" } }, "additionalProperties": false }, "manaV2NullableIPv4Address": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableIPv6Address": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableInterfaceConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2InterfaceConfig" } }, "additionalProperties": false }, "manaV2InterfaceConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "duplex": { "type": "string", "example": "example string" }, "ipsec": { "$ref": "#/components/schemas/manaV2InterfaceIPsecConfig" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "lan": { "type": "string", "example": "example string" }, "lldpEnabled": { "type": "boolean", "example": true }, "loopback": { "type": "boolean", "example": true }, "macsec": { "$ref": "#/components/schemas/manaV2NullableMaCsecConfiguration" }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "securityZone": { "type": "string", "example": "example string" }, "speed": { "type": "integer", "format": "int64", "example": 1234567891011 }, "subinterfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableInterfaceVlanConfig" } }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "v4TcpMss": { "$ref": "#/components/schemas/manaV2NullableTcpMssV4" }, "v6TcpMss": { "$ref": "#/components/schemas/manaV2NullableTcpMssV6" } }, "additionalProperties": false }, "manaV2NullableMaCsecConfiguration": { "type": "object", "properties": { "macsec": { "$ref": "#/components/schemas/manaV2MaCsecConfiguration" } }, "additionalProperties": false }, "manaV2MaCsecConfiguration": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true, "description": "Whether MACsec is enabled or disabled (required)" }, "encryptionEnforcementMode": { "type": "string", "example": "MACSEC_ENFORCEMENT_MODE_SHOULD_ENCRYPT", "description": "The encryption enforcement mode (required)" }, "globalSakConfiguration": { "$ref": "#/components/schemas/manaV2NullableSakConfiguration" }, "keyServerPriority": { "type": "integer", "format": "int64", "example": 255, "description": "The priority of the key server. Lower number means higher priority." }, "pskConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PskConfiguration" } }, "pskConfigurationsByNickname": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePskConfiguration" } }, "sakConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SakConfiguration" } }, "sakConfigurationsByLagMemberInterfaceId": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSakConfiguration" } }, "splitSakConfigByLagMember": { "type": "boolean", "example": true, "description": "Whether to allow individual SAK configurations for each lag member" }, "transparentVlan": { "type": "boolean", "example": true, "description": "Whether transparent VLAN is enabled or disabled" } }, "additionalProperties": false, "required": [ "enabled", "encryptionEnforcementMode", "globalSakConfiguration", "pskConfigurationsByNickname", "sakConfigurationsByLagMemberInterfaceId" ] }, "manaV2NullableSakConfiguration": { "type": "object", "properties": { "sak": { "$ref": "#/components/schemas/manaV2SakConfiguration" } }, "additionalProperties": false }, "manaV2NullablePskConfiguration": { "type": "object", "properties": { "psk": { "$ref": "#/components/schemas/manaV2PskConfiguration" } }, "additionalProperties": false }, "manaV2NullableInterfaceVlanConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2InterfaceVlanConfig" } }, "additionalProperties": false }, "manaV2InterfaceVlanConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "circuit": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "lan": { "type": "string", "example": "example string" }, "lldpEnabled": { "type": "boolean", "example": true }, "maxTransmissionUnit": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "securityZone": { "type": "string", "example": "example string" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "v4TcpMss": { "$ref": "#/components/schemas/manaV2NullableTcpMssV4" }, "v6TcpMss": { "$ref": "#/components/schemas/manaV2NullableTcpMssV6" }, "vlan": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vrrp": { "$ref": "#/components/schemas/manaV2NullableVrrpGroupConfig" } }, "additionalProperties": false }, "manaV2NullableTcpMssV4": { "type": "object", "properties": { "tcpMssV4": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableTcpMssV6": { "type": "object", "properties": { "tcpMssV6": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableLagInterfaceConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2LagInterfaceConfig" } }, "additionalProperties": false }, "manaV2LagInterfaceConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "lacp": { "$ref": "#/components/schemas/manaV2LacpConfig" }, "lagMembers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableLagMemberInterface" } }, "macsec": { "$ref": "#/components/schemas/manaV2NullableMaCsecConfiguration" }, "minimumMembers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "segment": { "type": "string", "example": "example string" }, "subinterfaces": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableInterfaceLagvlanConfig" } } }, "additionalProperties": false }, "manaV2NullableLagMemberInterface": { "type": "object", "properties": { "interface": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2NullableInterfaceLagvlanConfig": { "type": "object", "properties": { "interface": { "$ref": "#/components/schemas/manaV2InterfaceLagvlanConfig" } }, "additionalProperties": false }, "manaV2InterfaceLagvlanConfig": { "type": "object", "properties": { "adminStatus": { "type": "boolean", "example": true }, "alias": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "ipv4": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "ipv6": { "$ref": "#/components/schemas/manaV2InterfaceIpConfig" }, "segment": { "type": "string", "example": "example string" }, "vlan": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NatPolicyConfig": { "type": "object", "properties": { "natRulesets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableNatPolicyRulesetConfig" } } }, "additionalProperties": false }, "manaV2NullableNatPolicyRulesetConfig": { "type": "object", "properties": { "ruleset": { "$ref": "#/components/schemas/manaV2NatPolicyRulesetConfig" } }, "additionalProperties": false }, "manaV2NatPolicyRulesetConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "rules": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NATPolicyRulesetConfigNullableRule" } } }, "additionalProperties": false }, "manaV2NATPolicyRulesetConfigNullableRule": { "type": "object", "properties": { "rule": { "$ref": "#/components/schemas/manaV2NATPolicyRulesetConfigNullableRuleRule" } }, "additionalProperties": false }, "manaV2NATPolicyRulesetConfigNullableRuleRule": { "type": "object", "properties": { "advertisePreNatPrefixes": { "type": "boolean", "example": true }, "description": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "originalDstIpPrefix": { "type": "string", "example": "example string" }, "originalSrcIpPrefix": { "type": "string", "example": "example string" }, "seq": { "type": "integer", "format": "int64", "example": 1234567891011 }, "translatedDstIpPrefix": { "type": "string", "example": "example string" }, "translatedSrcIpPrefix": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableNtpConfig": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2NtpConfig" } }, "additionalProperties": false }, "manaV2NtpConfig": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string", "example": "example string" } }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableIPsecTunnelConfig": { "type": "object", "properties": { "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2IPsecTunnel" } }, "additionalProperties": false }, "manaV2IPsecTunnel": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "ikeInitiator": { "type": "boolean", "example": true }, "ipsecLabel": { "type": "string", "example": "ENUM_VALUE" }, "lan": { "type": "string", "example": "example string" }, "localAddressV4": { "type": "string", "example": "example string" }, "localAddressV6": { "type": "string", "example": "example string" }, "localCircuit": { "type": "string", "example": "example string" }, "localIkePeerIdentity": { "type": "string", "example": "example string" }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "presharedKey": { "type": "string", "example": "example string" }, "remoteAddressV4": { "type": "string", "example": "example string" }, "remoteAddressV6": { "type": "string", "example": "example string" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string" }, "routing": { "$ref": "#/components/schemas/manaV2IpsecRoutingConfig" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "vpnProfile": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2IpsecRoutingConfig": { "type": "object", "properties": { "bgp": { "$ref": "#/components/schemas/manaV2IPsecBgpRouteConfig" }, "static": { "$ref": "#/components/schemas/manaV2IPsecStaticRouteConfig" } }, "additionalProperties": false }, "manaV2IPsecBgpRouteConfig": { "type": "object", "properties": { "addressFamilies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableBgpNeighborAddressFamilyConfig" } }, "holdTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "keepaliveTimer": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "md5Password": { "$ref": "#/components/schemas/manaV2NullableMd5Password" }, "peerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sendCommunity": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2IPsecStaticRouteConfig": { "type": "object", "properties": { "destinationPrefix": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NullableSlaConformance": { "type": "object", "properties": { "slaConformance": { "$ref": "#/components/schemas/manaV2SlaConformance" } }, "additionalProperties": false }, "manaV2NullableSnmpConfig": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2SnmpConfig" } }, "additionalProperties": false }, "manaV2SnmpConfig": { "type": "object", "properties": { "communities": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpCommunityConfigValue" } }, "engineAuthenTraps": { "type": "boolean", "example": true }, "engineEnabled": { "type": "boolean", "example": true }, "engineEndpoints": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpEngineEndpointConfigValue" } }, "engineHighCpuTraps": { "type": "boolean", "example": true }, "engineHighMemoryTraps": { "type": "boolean", "example": true }, "engineIdAdminOctets": { "type": "string", "example": "example string" }, "engineIdAdminText": { "type": "string", "example": "example string" }, "engineIdIpv4": { "type": "string", "example": "example string" }, "engineIdIpv6": { "type": "string", "example": "example string" }, "engineIdMac": { "type": "string", "example": "example string" }, "engineIdRaw": { "type": "string", "example": "example string" }, "engineLocalAcessV4": { "type": "boolean", "example": true }, "engineLocalAcessV6": { "type": "boolean", "example": true }, "engineUserHints": { "type": "boolean", "example": true }, "engineUserValidation": { "type": "boolean", "example": true }, "globalId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isGlobalSync": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "notifyFilterProfiles": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpNotifyFilterProfileConfigValue" } }, "snmpVersion": { "type": "string", "example": "ENUM_VALUE" }, "targets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpTargetConfigValue" } }, "usmLocalUsers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableUsmLocalUserConfigValue" } }, "usmRemoteUsers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableUsmRemoteUserConfigValue" } }, "v2cEnabled": { "type": "boolean", "example": true }, "v3Enabled": { "type": "boolean", "example": true }, "vacmGroups": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableVacmGroupValue" } }, "vacmViews": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpVacmViewValue" } } }, "additionalProperties": false }, "manaV2NullableSnmpCommunityConfigValue": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSnmpEngineEndpointConfigValue": { "type": "object", "properties": { "engineEndpoint": { "$ref": "#/components/schemas/manaV2SnmpEngineEndpointConfig" } }, "additionalProperties": false }, "manaV2SnmpEngineEndpointConfig": { "type": "object", "properties": { "addresses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpEngineEndpointsAddress" } }, "autoIpv4": { "type": "boolean", "example": true }, "autoIpv6": { "type": "boolean", "example": true }, "interface": { "type": "string", "example": "example string" }, "lanSegment": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSnmpEngineEndpointsAddress": { "type": "object", "properties": { "address": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSnmpNotifyFilterProfileConfigValue": { "type": "object", "properties": { "notifyFilterProfile": { "$ref": "#/components/schemas/manaV2SnmpNotifyFilterProfileConfig" } }, "additionalProperties": false }, "manaV2SnmpNotifyFilterProfileConfig": { "type": "object", "properties": { "includeExcludeList": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NotifyFilterProfileIncludeConfig" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NotifyFilterProfileIncludeConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2NullableSnmpTargetConfigValue": { "type": "object", "properties": { "target": { "$ref": "#/components/schemas/manaV2SnmpTargetConfig" } }, "additionalProperties": false }, "manaV2SnmpTargetConfig": { "type": "object", "properties": { "community": { "type": "string", "example": "example string" }, "lanSegment": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "notifyFilterProfile": { "type": "string", "example": "example string" }, "notifyType": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "targetIp": { "type": "string", "example": "example string" }, "targetType": { "type": "string", "example": "ENUM_VALUE" }, "usmSecurityLevel": { "type": "string", "example": "ENUM_VALUE" }, "usmUserName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableUsmLocalUserConfigValue": { "type": "object", "properties": { "localUser": { "$ref": "#/components/schemas/manaV2SnmpUsmLocalUserConfig" } }, "additionalProperties": false }, "manaV2SnmpUsmLocalUserConfig": { "type": "object", "properties": { "authPassphrase": { "type": "string", "example": "example string" }, "authProtocol": { "type": "string", "example": "ENUM_VALUE" }, "encryptionPassphrase": { "type": "string", "example": "example string" }, "encryptionProtocol": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableUsmRemoteUserConfigValue": { "type": "object", "properties": { "remoteUser": { "$ref": "#/components/schemas/manaV2SnmpUsmRemoteUserConfig" } }, "additionalProperties": false }, "manaV2SnmpUsmRemoteUserConfig": { "type": "object", "properties": { "authLocKey": { "type": "string", "example": "example string" }, "authProtocol": { "type": "string", "example": "ENUM_VALUE" }, "encryptionLocKey": { "type": "string", "example": "example string" }, "encryptionProtocol": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableVacmGroupValue": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/manaV2VacmGroupConfig" } }, "additionalProperties": false }, "manaV2VacmGroupConfig": { "type": "object", "properties": { "accesses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpVacmGroupAccessValue" } }, "members": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpVacmGroupMemberValue" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSnmpVacmGroupAccessValue": { "type": "object", "properties": { "access": { "$ref": "#/components/schemas/manaV2SnmpVacmGroupAccessConfig" } }, "additionalProperties": false }, "manaV2SnmpVacmGroupAccessConfig": { "type": "object", "properties": { "context": { "type": "string", "example": "example string" }, "contextMatch": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "readView": { "type": "string", "example": "example string" }, "securityLevel": { "type": "string", "example": "ENUM_VALUE" }, "securityModel": { "type": "string", "example": "ENUM_VALUE" }, "writeView": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2NullableSnmpVacmGroupMemberValue": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/manaV2SnmpVacmGroupMemberConfig" } }, "additionalProperties": false }, "manaV2SnmpVacmGroupMemberConfig": { "type": "object", "properties": { "community": { "type": "string", "example": "example string" }, "securityModel": { "type": "string", "example": "ENUM_VALUE" }, "securityName": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2NullableSnmpVacmViewValue": { "type": "object", "properties": { "view": { "$ref": "#/components/schemas/manaV2SnmpVacmViewConfig" } }, "additionalProperties": false }, "manaV2SnmpVacmViewConfig": { "type": "object", "properties": { "includeExcludeList": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2SnmpVacmViewIncludeConfig" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SnmpVacmViewIncludeConfig": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1DevicesDeviceIdConfigPutResponse": { "type": "object", "properties": { "jobId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "workflowId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdConnectivityGetResponse": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphEdge" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConnectivityGraphNode" } } }, "additionalProperties": false }, "v1DevicesDeviceIdDhcpServerLeasesGetResponse": { "type": "object", "properties": { "pools": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DhcpServerPool" } } }, "additionalProperties": false }, "v1DevicesSessionStatusPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1DevicesSessionStatusPostResponse": { "type": "object", "properties": { "bgpSessionDataMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/v1DevicesSessionStatusPostResponseData" } }, "bgpSessionMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/v1DevicesSessionStatusPostResponseData" } }, "bgpSessionStates": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesSessionStatusPostResponseData" } } }, "additionalProperties": false }, "v1DevicesSessionStatusPostResponseData": { "type": "object", "properties": { "coreBgpNeighborsCount": { "type": "integer", "format": "int32", "example": 123 }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "odpBgpNeighborsCount": { "type": "integer", "format": "int32", "example": 123 }, "wanInterfacesCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1ExtranetsGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetPolicy" } } }, "additionalProperties": false }, "manaV2ExtranetPolicy": { "type": "object", "properties": { "auto": { "$ref": "#/components/schemas/manaV2ExtranetAutoReverseRoutes" }, "branches": { "$ref": "#/components/schemas/manaV2PolicyTarget" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "createdBy": { "type": "string", "example": "example string" }, "description": { "type": "string", "example": "example string" }, "hostPrefixSet": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSet" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "manual": { "$ref": "#/components/schemas/manaV2ExtranetManualReverseRoutes" }, "name": { "type": "string", "example": "example string" }, "sharedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "sharedSegment": { "$ref": "#/components/schemas/manaV2Vrf" }, "source": { "$ref": "#/components/schemas/manaV2PolicyTarget" }, "targetSegments": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Vrf" } }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "manaV2ExtranetAutoReverseRoutes": { "type": "object", "properties": { "autoPropagate": { "type": "boolean", "example": true }, "excludedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2PolicyTarget": { "type": "object", "properties": { "excludedDevices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Device" } }, "prefixSet": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSet" }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Site" } } }, "additionalProperties": false }, "manaV2EnterprisePrefixSet": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetEntry" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "mode": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetEntry": { "type": "object", "properties": { "ipPrefix": { "type": "string", "example": "example string" }, "maskLower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "maskUpper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2ExtranetManualReverseRoutes": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1ExtranetsIdGetResponse": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetPolicy" } }, "additionalProperties": false }, "v1ExtranetsIdStatusGetResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetDeviceStatus" } } }, "additionalProperties": false }, "manaV2ExtranetDeviceStatus": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "siteName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetPolicyInput" } }, "additionalProperties": false }, "manaV2ExtranetPolicyInput": { "type": "object", "properties": { "auto": { "$ref": "#/components/schemas/manaV2ExtranetAutoReverseRoutes" }, "branches": { "$ref": "#/components/schemas/manaV2PolicyTargetInput" }, "description": { "type": "string", "example": "example string" }, "hostPrefixSet": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetInput" }, "manual": { "$ref": "#/components/schemas/manaV2ExtranetManualReverseRoutes" }, "name": { "type": "string", "example": "example string" }, "sharedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "sharedSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "source": { "$ref": "#/components/schemas/manaV2PolicyTargetInput" }, "targetSegments": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2PolicyTargetInput": { "type": "object", "properties": { "excludedDevices": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "prefixSet": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetInput" }, "sites": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetInput": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetInputEntry" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "mode": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetInputEntry": { "type": "object", "properties": { "ipPrefix": { "type": "string", "example": "example string" }, "maskLower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "maskUpper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1ExtranetsPostResponse": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetPolicy" } }, "additionalProperties": false }, "v1ExtranetsIdPutRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetPolicyInput" } }, "additionalProperties": false }, "v1ExtranetsIdPutResponse": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetPolicy" } }, "additionalProperties": false }, "v1ExtranetsIdDeleteResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetDeviceStatus" } } }, "additionalProperties": false }, "v1ExtranetsSourceSegmentsPostRequest": { "type": "object", "properties": { "filter": { "type": "string", "example": "example string" }, "target": { "$ref": "#/components/schemas/manaV2PolicyTargetInput" } }, "additionalProperties": false }, "v1ExtranetsSourceSegmentsPostResponse": { "type": "object", "properties": { "vrfs": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Vrf" } } }, "additionalProperties": false }, "v1ExtranetsResolvePolicyTargetPostRequest": { "type": "object", "properties": { "policyTarget": { "$ref": "#/components/schemas/manaV2PolicyTargetInput" } }, "additionalProperties": false }, "v1ExtranetsResolvePolicyTargetPostResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Device" } } }, "additionalProperties": false }, "v1ExtranetsIdApplyPostRequest": { "type": "object", "properties": { "targetDevices": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1ExtranetsIdApplyPostResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetDeviceStatus" } }, "jobId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1ExtranetB2bProducerPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerPolicy" }, "serviceName": { "type": "string", "example": "example string", "description": " (required)" }, "serviceType": { "type": "string", "example": "ENUM_VALUE", "description": "Branded extranet service type (peering_service, client_to_server, …) (required)" } }, "additionalProperties": false, "required": [ "policy", "serviceName", "serviceType" ] }, "manaV2ExtranetServiceProducerPolicy": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "globalObjectDeviceSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "globalObjectOps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceOps" } }, "natTranslationMode": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationMode" }, "prefixTags": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPrefixTag" } }, "serviceLanSegment": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "LAN segment ID for the service" }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false }, "manaV2GlobalObjectServiceSummaries": { "type": "object", "properties": { "routingPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalObjectSummary" } } }, "additionalProperties": false }, "manaV2GlobalObjectSummary": { "type": "object", "properties": { "attachPoint": { "type": "string", "example": "ENUM_VALUE" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipVersion": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "numAttachedDevices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numAttachedSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numFailures": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numInSyncDevices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numOverrideDevices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numPolicies": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numPrefixes": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numRules": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numStatements": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "trafficPolicyType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2GlobalObjectServiceOps": { "type": "object", "properties": { "routingPolicyOps": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationMode": { "type": "object", "properties": { "centralized": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationCentralized" }, "decentralized": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationDecentralized" }, "peerToPeer": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationPeerToPeer" } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationCentralized": { "type": "object", "properties": { "prefixes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationDevicePrefixes" } } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationDevicePrefixes": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "IPv4 CIDR NAT pool(s) for the device" } } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationDecentralized": { "type": "object", "properties": { "prefixes": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationDevicePrefixes" } } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationPeerToPeer": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationPeerToPeerPrefix" } } }, "additionalProperties": false }, "manaV2ExtranetNatTranslationPeerToPeerPrefix": { "type": "object", "properties": { "outsideNatPrefix": { "type": "string", "example": "100.1.2.0/24", "description": "Optional outside address presented for prefix on the far side of the attachment; omit for no NAT on that prefix" }, "prefix": { "type": "string", "example": "10.1.2.0/24", "description": "At match: customer export prefix. At consumer accept/update (peering): subscribed service prefix" } }, "additionalProperties": false }, "manaV2B2bExtranetPrefixTag": { "type": "object", "properties": { "prefix": { "type": "string", "example": "10.1.2.0/24", "description": "Prefix advertised by the service (required)" }, "tag": { "type": "string", "example": "example string", "description": "Tag for the prefix" } }, "additionalProperties": false, "required": [ "prefix" ] }, "manaV2B2bSiteInformation": { "type": "object", "properties": { "bwAllocationSiteLists": { "type": "integer", "format": "int32", "example": 123, "description": "Total Bandwidth allocation for the service on these site lists" }, "bwAllocationSites": { "type": "integer", "format": "int32", "example": 123, "description": "Total Bandwidth allocation for the service on these sites" }, "policerSiteLists": { "$ref": "#/components/schemas/manaV2Policer" }, "policerSites": { "$ref": "#/components/schemas/manaV2Policer" }, "siteLists": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Site list IDs where the service is deployed" } }, "sites": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Site IDs where the service is deployed" } } }, "additionalProperties": false }, "manaV2Policer": { "type": "object", "properties": { "burstSize": { "type": "integer", "format": "int32", "example": 123, "description": "Burst size for the policer (required)" }, "bw": { "type": "integer", "format": "int32", "example": 123, "description": "Bandwidth for the policer (required)" } }, "additionalProperties": false, "required": [ "burstSize", "bw" ] }, "v1ExtranetB2bProducerPostResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServicePolicyResponse" } }, "additionalProperties": false }, "manaV2ExtranetServicePolicyResponse": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerPolicy" }, "serviceName": { "type": "string", "example": "example string" }, "serviceType": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bProducerReviewPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerPolicy" }, "serviceName": { "type": "string", "example": "example string", "description": " (required)" }, "serviceType": { "type": "string", "example": "ENUM_VALUE", "description": "Branded extranet service type (peering_service, client_to_server, …) (required)" } }, "additionalProperties": false, "required": [ "policy", "serviceName", "serviceType" ] }, "v1ExtranetB2bProducerReviewPostResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServicePolicyResponse" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdGetResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServicePolicyResponse" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdPutRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerPolicy" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdPutResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "consumerActivityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServicePolicyResponse" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdStatusPutRequest": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdStatusPutResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bProducerIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetB2bProducerIdCustomersGetResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerCustomer" } } }, "additionalProperties": false }, "manaV2ExtranetServiceProducerCustomer": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "customerId": { "type": "string", "example": "example string" }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedServices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersPostRequest": { "type": "object", "properties": { "invite": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerInvite" }, "name": { "type": "string", "example": "example string", "description": "Partner display name (required)" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Graphiant peer vs guest (non-Graphiant) partner (required)" } }, "additionalProperties": false, "required": [ "invite", "name", "type" ] }, "manaV2ExtranetServiceCustomerInvite": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Admin emails for the partner" } }, "maximumNumberOfSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Maximum number of consumer sites" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "invite": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerInvite" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdDetailsGetResponse": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "name": { "type": "string", "example": "example string" }, "numSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdPutRequest": { "type": "object", "properties": { "invite": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerInvite" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdPutResponse": { "type": "object", "properties": { "invite": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerInvite" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdDeleteResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "consumerActivityId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdRetryPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetB2bCustomersIdRetryPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetB2bMatchesPostRequest": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "match": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } }, "additionalProperties": false }, "manaV2B2bExtranetMatch": { "type": "object", "properties": { "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Consumer client prefixes agreed at match (flat list; scoped to LAN segments at consumer accept)" } }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "natTranslationMode": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationMode" }, "numCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Number of customers subscribed to the service" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id" }, "servicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPrefixTag" } } }, "additionalProperties": false }, "v1ExtranetB2bMatchesPostResponse": { "type": "object", "properties": { "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } } }, "additionalProperties": false }, "v1ExtranetB2bMatchesCustomersPostRequest": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerCustomer" } }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1ExtranetB2bMatchesCustomersPostResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceProducerCustomer" } } }, "additionalProperties": false }, "v1ExtranetB2bMatchesReviewPostRequest": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "match": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesReviewPostResponse": { "type": "object", "properties": { "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matches": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdGetResponse": { "type": "object", "properties": { "customerName": { "type": "string", "example": "example string" }, "match": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdPutRequest": { "type": "object", "properties": { "match": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdPutResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "match": { "$ref": "#/components/schemas/manaV2B2bExtranetMatch" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdStatusPutRequest": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdStatusPutResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesPausePutRequest": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesPausePutResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdDeleteResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "consumerActivityId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetB2bCustomersIdMatchesSummaryGetResponse": { "type": "object", "properties": { "matches": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerMatchSummary" } } }, "additionalProperties": false }, "manaV2ExtranetServiceCustomerMatchSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "serviceType": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdDetailsGetResponse": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetMatchConsumerDetails" } } }, "additionalProperties": false }, "manaV2B2bExtranetMatchConsumerDetails": { "type": "object", "properties": { "consumerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "customer": { "$ref": "#/components/schemas/manaV2B2BExtranetMatchConsumerDetailsCustomer" }, "oldConsumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "oldServicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2BExtranetMatchConsumerDetailsProducerPrefix" } }, "service": { "$ref": "#/components/schemas/manaV2B2BExtranetMatchConsumerDetailsService" }, "servicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2BExtranetMatchConsumerDetailsProducerPrefix" } } }, "additionalProperties": false }, "manaV2B2BExtranetMatchConsumerDetailsCustomer": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "companyName": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "numSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2B2BExtranetMatchConsumerDetailsProducerPrefix": { "type": "object", "properties": { "customerTranslatedPrefix": { "type": "string", "example": "example string" }, "prefix": { "type": "string", "example": "example string" }, "tag": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2B2BExtranetMatchConsumerDetailsService": { "type": "object", "properties": { "companyName": { "type": "string", "example": "example string" }, "contactEmail": { "type": "array", "items": { "type": "string", "example": "example string" } }, "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdConsumerPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id being consumed" } }, "additionalProperties": false }, "manaV2ExtranetServiceConsumerPolicy": { "type": "object", "properties": { "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2ExtranetConsumerLanPrefixes" } }, "globalObjectOps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceOps" } }, "natTranslationMode": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationMode" }, "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2GuestConsumerSiteToSiteVpnConfig" }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false, "required": [ "consumerLanSegments" ] }, "manaV2ExtranetConsumerLanPrefixes": { "type": "object", "properties": { "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Consumer client prefixes on this LAN" } }, "servicePrefixDnat": { "type": "object", "additionalProperties": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2GuestConsumerSiteToSiteVpnConfig": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ipsecGatewayDetails": { "$ref": "#/components/schemas/manaV2IPsecGatewayDetails" }, "ipsecGatewayPeers": { "$ref": "#/components/schemas/manaV2IPsecGatewayPeersConfig" }, "regionId": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2IPsecGatewayDetails": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "ikeInitiator": { "type": "boolean", "example": true }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string" }, "routing": { "$ref": "#/components/schemas/manaV2IpsecRoutingConfig" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnel1": { "$ref": "#/components/schemas/manaV2IPsecGatewayTunnelDetails" }, "tunnel2": { "$ref": "#/components/schemas/manaV2IPsecGatewayTunnelDetails" }, "vpnProfile": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2IPsecGatewayTunnelDetails": { "type": "object", "properties": { "insideIpv4Cidr": { "type": "string", "example": "example string" }, "insideIpv6Cidr": { "type": "string", "example": "example string" }, "localIkePeerIdentity": { "type": "string", "example": "example string" }, "psk": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2IPsecGatewayPeersConfig": { "type": "object", "properties": { "name": { "type": "string", "example": "example string", "description": "Name of the IPsec gateway service" }, "remotePeers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IPsecGatewayRemotePeer" } }, "routing": { "$ref": "#/components/schemas/manaV2IpsecRoutingConfig" } }, "additionalProperties": false }, "manaV2IPsecGatewayRemotePeer": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "ikeInitiator": { "type": "boolean", "example": true, "description": "When true, Graphiant initiates IKE for this peer" }, "mtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string", "description": "Optional display name or label for this peer; used when generating tunnel names" }, "remoteIkePeerIdentity": { "type": "string", "example": "example string", "description": "IKE identity of the remote peer" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnel1": { "$ref": "#/components/schemas/manaV2IPsecGatewayTunnelDetails" }, "tunnel2": { "$ref": "#/components/schemas/manaV2IPsecGatewayTunnelDetails" }, "vpnProfile": { "type": "string", "example": "example string", "description": "Enterprise IPsec VPN profile name for this peer" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdConsumerPostResponse": { "type": "object", "properties": { "consumerActivityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdConsumerCheckPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" }, "serviceId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id being consumed" } }, "additionalProperties": false }, "v1ExtranetB2bMatchesMatchIdConsumerCheckPostResponse": { "type": "object", "properties": { "consumerActivityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersCustomerIdGetResponse": { "type": "object", "properties": { "globalObjectDeviceSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipsecTunnelConfig": { "type": "array", "items": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersCustomerIdGetResponseIpsecVpnTunnelConfig" } }, "matchDetails": { "$ref": "#/components/schemas/manaV2B2bExtranetMatchConsumerDetails" }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "peerType": { "type": "string", "example": "ENUM_VALUE" }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" }, "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2GuestConsumerSiteToSiteVpnConfig" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersCustomerIdGetResponseIpsecVpnTunnelConfig": { "type": "object", "properties": { "bgpGraphiantAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpLocalAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborHoldTime": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborIpv4": { "type": "string", "example": "example string" }, "bgpNeighborIpv6": { "type": "string", "example": "example string" }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dpdRetries": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "graphiantDestinationIp": { "type": "string", "example": "example string" }, "graphiantIkeId": { "type": "string", "example": "example string" }, "graphiantOuterTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIpv6": { "type": "string", "example": "example string" }, "ikeAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ikeAuthenticationMethod": { "type": "string", "example": "example string" }, "ikeDhAlgorithm": { "type": "string", "example": "example string" }, "ikeEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ikeLifetime": { "type": "string", "example": "example string" }, "ikePresharedKey": { "type": "string", "example": "example string" }, "ikeVersion": { "type": "integer", "format": "int32", "example": 123 }, "ipsecAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ipsecEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ipsecExtendedSequenceNumber": { "type": "boolean", "example": true }, "ipsecLifetime": { "type": "string", "example": "example string" }, "ipsecMode": { "type": "string", "example": "example string" }, "ipsecPfsAlgorithm": { "type": "string", "example": "example string" }, "ipsecProtocol": { "type": "string", "example": "example string" }, "localIkeId": { "type": "string", "example": "example string" }, "localOuterTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIpv6": { "type": "string", "example": "example string" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnelMtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdPutRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdPutResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2ExtranetServiceConsumerPolicy" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdPrefixesPutRequest": { "type": "object", "properties": { "natTranslationMode": { "$ref": "#/components/schemas/manaV2ExtranetNatTranslationMode" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdPrefixesPutResponse": { "type": "object", "properties": { "consumerActivityId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetB2bProducerIdDeviceStatusGetResponse": { "type": "object", "properties": { "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetStatusSummary" } } }, "additionalProperties": false }, "manaV2B2bExtranetStatusSummary": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceStatus": { "type": "string", "example": "ENUM_VALUE" }, "location": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetB2bConsumersIdDeviceStatusGetResponse": { "type": "object", "properties": { "serviceStatus": { "type": "string", "example": "ENUM_VALUE" }, "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetStatusSummary" } } }, "additionalProperties": false }, "v1ExtranetB2bServicesSummaryGetResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceSummary" } } }, "additionalProperties": false }, "manaV2ExtranetServiceSummary": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isPublisher": { "type": "boolean", "example": true, "description": "True when this enterprise publishes the service; false when consuming a remote producer" }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Service LAN segment when is_publisher and VRF exists" }, "lastUpdated": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "serverPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Producer prefix tags (legacy ServerIpAddress on publisher rows)" } }, "serviceName": { "type": "string", "example": "example string" }, "serviceType": { "type": "string", "example": "ENUM_VALUE" }, "sites": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "status": { "type": "string", "example": "ENUM_VALUE" }, "totalCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1ExtranetB2bCustomersSummaryGetResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetServiceCustomerSummary" } } }, "additionalProperties": false }, "manaV2ExtranetServiceCustomerSummary": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedServices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringProducerPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceProducerPolicy" }, "serviceName": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Type of the service whether it is application or peering (required)" } }, "additionalProperties": false, "required": [ "policy", "type" ] }, "manaV2B2bExtranetPeeringServiceProducerPolicy": { "type": "object", "properties": { "description": { "type": "string", "example": "example string", "description": "Description for the service" }, "globalObjectOps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceOps" } }, "prefixTags": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPrefixTag" } }, "serviceLanSegment": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "LAN segment ID for the service (required)" }, "site": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Type of the service whether it is application or peering (required)" } }, "additionalProperties": false, "required": [ "prefixTags", "serviceLanSegment", "site", "type" ] }, "v1ExtranetsB2bPeeringProducerPostResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServicePolicyResponse" } }, "additionalProperties": false }, "manaV2B2bExtranetPeeringServicePolicyResponse": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceProducerPolicy" }, "serviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringProducerIdGetResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServicePolicyResponse" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringProducerIdMatchingCustomersSummaryGetResponse": { "type": "object", "properties": { "info": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2CustomerMatchInfo" } } }, "additionalProperties": false }, "manaV2CustomerMatchInfo": { "type": "object", "properties": { "customerId": { "type": "string", "example": "example string" }, "customerName": { "type": "string", "example": "example string" }, "emails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedServices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "peerType": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringCustomerPostRequest": { "type": "object", "properties": { "invite": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceCustomerInvite" }, "name": { "type": "string", "example": "example string", "description": "Name of the peering service customer (required)" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Type of the peerings servicecustomer whether it is a graphiant or non-graphiant (required)" } }, "additionalProperties": false, "required": [ "invite", "name", "type" ] }, "manaV2B2bExtranetPeeringServiceCustomerInvite": { "type": "object", "properties": { "adminEmail": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Admin emails for the peering service customer (required)" } }, "maximumNumberOfSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Maximum number of sites for the peering service customer (required)" } }, "additionalProperties": false, "required": [ "adminEmail", "maximumNumberOfSites" ] }, "v1ExtranetsB2bPeeringCustomerPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "response": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceCustomerInvite" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringCustomerIdDeleteResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string" }, "consumerActivityId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringCustomerIdGetResponse": { "type": "object", "properties": { "customerName": { "type": "string", "example": "example string" }, "emails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "numSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringMatchServiceToCustomerPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "ID of the customer (required)" }, "service": { "$ref": "#/components/schemas/manaV2B2bExtranetMatchServiceToCustomer" } }, "additionalProperties": false, "required": [ "id", "service" ] }, "manaV2B2bExtranetMatchServiceToCustomer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "ID of the service being subscribed by the customer (required)" }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "nat": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bNat" } }, "numCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Number of customers subscribed to the service" }, "servicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPrefixTag" } } }, "additionalProperties": false, "required": [ "id", "nat", "servicePrefixes" ] }, "manaV2B2bNat": { "type": "object", "properties": { "outsideNatPrefix": { "type": "string", "example": "100.1.2.0/24", "description": "Outside NAT prefix for the customer prefix" }, "prefix": { "type": "string", "example": "10.1.2.0/24", "description": "Prefix imported into the service (required)" } }, "additionalProperties": false, "required": [ "prefix" ] }, "v1ExtranetsB2bPeeringMatchServiceToCustomerPostResponse": { "type": "object", "properties": { "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "service": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetMatchServiceToCustomer" } } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringMatchServiceToCustomerServiceStatusPutRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "match ID for the customer's service subscription (required)" }, "status": { "type": "string", "example": "B2B_PEERING_SERVICE_STATUS_PAUSED", "description": "Customer’s service status: Paused or Active (required)" } }, "additionalProperties": false, "required": [ "id", "status" ] }, "v1ExtranetsB2bPeeringMatchServiceToCustomerServiceStatusPutResponse": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringMatchServicesSummaryIdGetResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetCustomerMatchServicesSummary" } } }, "additionalProperties": false }, "manaV2B2bExtranetCustomerMatchServicesSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringMatchServiceToCustomerIdGetResponse": { "type": "object", "properties": { "customerName": { "type": "string", "example": "example string" }, "matchDetails": { "$ref": "#/components/schemas/manaV2B2bExtranetMatchServiceToCustomer" }, "matchId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringMatchServiceToCustomerIdDeleteResponse": { "type": "object", "properties": { "activityId": { "type": "string", "example": "example string", "description": "activity id for the delete operation (required)" }, "consumerActivityId": { "type": "string", "example": "example string", "description": "activity id for the consumer delete operation (required)" } }, "additionalProperties": false }, "v1ExtranetsB2bGeneralCustomersSummaryGetResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetCustomerServicesSummary" } } }, "additionalProperties": false }, "manaV2B2bExtranetCustomerServicesSummary": { "type": "object", "properties": { "adminEmails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedServices": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bGeneralServicesSummaryGetResponse": { "type": "object", "properties": { "info": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetApplication" } } }, "additionalProperties": false }, "manaV2B2bExtranetApplication": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isPublisher": { "type": "boolean", "example": true }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "matchedCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "serverIpAddress": { "type": "array", "items": { "type": "string", "example": "example string" } }, "status": { "type": "string", "example": "ENUM_VALUE" }, "totalCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "totalSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bPostRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetProducerPolicy" }, "serviceName": { "type": "string", "example": "example string", "description": "Name of the service (required)" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Type of the service whether it is application or peering (required)" } }, "additionalProperties": false, "required": [ "policy", "serviceName", "type" ] }, "manaV2B2bExtranetProducerPolicy": { "type": "object", "properties": { "description": { "type": "string", "example": "example string", "description": "Description for the service" }, "globalObjectDeviceSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "globalObjectSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "natPools": { "type": "array", "items": { "type": "string", "example": "example string", "description": "NAT pools for the service (required)" } }, "prefixTags": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPrefixTag" } }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ApplicationProfile" } }, "serviceLanSegment": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "LAN segment for the service (required)" }, "servicePrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes advertised by the service (required)" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } }, "sla": { "$ref": "#/components/schemas/manaV2SlaInformation" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE", "description": "Type of the service whether it is application or peering (required)" }, "unmatchedCustomers": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false, "required": [ "natPools", "serviceLanSegment", "servicePrefixes", "sites", "type" ] }, "manaV2ApplicationProfile": { "type": "object", "properties": { "portRange": { "type": "string", "example": "example string", "description": "Port Range" }, "ports": { "type": "array", "items": { "type": "integer", "format": "int32", "example": 123, "description": "Ports for the application profile (required)" } }, "protocol": { "type": "integer", "format": "int32", "example": 123, "description": "Protocol for the application profile (required)" } }, "additionalProperties": false, "required": [ "ports", "protocol" ] }, "manaV2SlaInformation": { "type": "object", "properties": { "backupCircuit": { "type": "string", "example": "ENUM_VALUE", "description": "Backup circuit for the SLA information" }, "class": { "type": "string", "example": "ENUM_VALUE", "description": "Class for the SLA information" }, "primaryCircuit": { "type": "string", "example": "ENUM_VALUE", "description": "Primary circuit for the SLA information" } }, "additionalProperties": false }, "v1ExtranetsB2bPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPolicyResponse" } }, "additionalProperties": false }, "manaV2B2bExtranetPolicyResponse": { "type": "object", "properties": { "dnsName": { "type": "string", "example": "example string" }, "inboundSecurityRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRule" } }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetProducerPolicy" }, "serviceName": { "type": "string", "example": "example string" }, "trafficRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2TrafficPolicyRule" } } }, "additionalProperties": false }, "manaV2SecurityPolicyRule": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "implicit": { "type": "boolean", "example": true }, "match": { "$ref": "#/components/schemas/manaV2PolicyMatch" }, "policyRuleIndex": { "type": "integer", "format": "int64", "example": 1234567891011 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2PolicyMatch": { "type": "object", "properties": { "destinationPort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "destinationPrefix": { "type": "string", "example": "example string" }, "icmpType": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "protocol": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePort": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "sourcePrefix": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2TrafficPolicyRule": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/manaV2TrafficPolicyAction" }, "match": { "$ref": "#/components/schemas/manaV2PolicyMatch" }, "policyRuleIndex": { "type": "integer", "format": "int64", "example": 1234567891011 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2TrafficPolicyAction": { "type": "object", "properties": { "backup": { "type": "string", "example": "ENUM_VALUE", "description": "Backup circuit for the traffic policy action" }, "class": { "type": "string", "example": "ENUM_VALUE", "description": "Class for the traffic policy action" }, "primary": { "type": "string", "example": "ENUM_VALUE", "description": "Primary circuit for the traffic policy action" }, "result": { "type": "string", "example": "ENUM_VALUE", "description": "Result for the traffic policy action" } }, "additionalProperties": false }, "v1ExtranetsB2bIdPutRequest": { "type": "object", "properties": { "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetProducerPolicy" } }, "additionalProperties": false, "required": [ "policy" ] }, "v1ExtranetsB2bIdPutResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPolicyResponse" } }, "additionalProperties": false }, "v1ExtranetsB2bIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetsB2bIdProducerGetResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "$ref": "#/components/schemas/manaV2B2bExtranetPolicyResponse" } }, "additionalProperties": false }, "v1ExtranetsB2bProducerDeviceStatusIdGetResponse": { "type": "object", "properties": { "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetStatusSummary" } } }, "additionalProperties": false }, "v1ExtranetsB2bProducersSummaryGetResponse": { "type": "object", "properties": { "info": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetApplication" } } }, "additionalProperties": false }, "v1ExtranetsB2bIdCustomerSummaryGetResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bApplicationCustomerSummary" } } }, "additionalProperties": false }, "manaV2B2bApplicationCustomerSummary": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1ExtranetsB2bIdCustomerPostRequest": { "type": "object", "properties": { "invites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetApplicationInvite" } } }, "additionalProperties": false, "required": [ "invites" ] }, "manaV2B2bExtranetApplicationInvite": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string", "description": "Admin email of the customer (required)" }, "consumerBurstSize": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Maximum Burst size per site for the customer (required)" }, "consumerBwSite": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Maximum Bandwidth allocation per site for the customer (required)" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Enterprise ID of the customer (required)" }, "maximumSiteCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0, "description": "Maximum number of sites for the customer (required)" }, "servicePrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "List of service prefixes for the application" } } }, "additionalProperties": false, "required": [ "adminEmail", "consumerBurstSize", "consumerBwSite", "enterpriseId", "maximumSiteCount" ] }, "v1ExtranetsB2bIdCustomerPostResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetApplicationInviteResponse" } } }, "additionalProperties": false }, "manaV2B2bExtranetApplicationInviteResponse": { "type": "object", "properties": { "adminEmail": { "type": "string", "example": "example string" }, "consumerBurstSize": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "consumerBwSite": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "maximumSiteCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "servicePrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1ExtranetsB2bCustomerIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerMatchIdMatchDetailsGetResponse": { "type": "object", "properties": { "details": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetServiceCustomerMatchDetails" } } }, "additionalProperties": false }, "manaV2B2bExtranetServiceCustomerMatchDetails": { "type": "object", "properties": { "consumerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "customer": { "$ref": "#/components/schemas/manaV2B2BExtranetServiceCustomerMatchDetailsCustomer" }, "oldConsumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "oldServicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2BExtranetServiceCustomerMatchDetailsProducerPrefix" } }, "service": { "$ref": "#/components/schemas/manaV2B2BExtranetServiceCustomerMatchDetailsService" }, "servicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2BExtranetServiceCustomerMatchDetailsProducerPrefix" } } }, "additionalProperties": false }, "manaV2B2BExtranetServiceCustomerMatchDetailsCustomer": { "type": "object", "properties": { "companyName": { "type": "string", "example": "example string" }, "emails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "numSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2B2BExtranetServiceCustomerMatchDetailsProducerPrefix": { "type": "object", "properties": { "customerTranslatedPrefix": { "type": "string", "example": "example string" }, "prefix": { "type": "string", "example": "example string" }, "tag": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2B2BExtranetServiceCustomerMatchDetailsService": { "type": "object", "properties": { "companyName": { "type": "string", "example": "example string" }, "contactEmail": { "type": "array", "items": { "type": "string", "example": "example string" } }, "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerMatchIdPostRequest": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "globalObjectOps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceOps" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "ID of the service which is being consumed by the customer (required)" }, "nat": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bNat" } }, "policy": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceConsumerLanSegmentPolicy" } }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } }, "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2GuestConsumerSiteToSiteVpnConfig" } }, "additionalProperties": false, "required": [ "id", "nat", "policy", "siteInformation" ] }, "manaV2B2bExtranetPeeringServiceConsumerLanSegmentPolicy": { "type": "object", "properties": { "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerMatchIdPostResponse": { "type": "object", "properties": { "consumerActivityId": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "nat": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bNat" } }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerIdPrefixesPutRequest": { "type": "object", "properties": { "servicePrefixes": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bNat" } } }, "additionalProperties": false, "required": [ "servicePrefixes" ] }, "v1ExtranetsB2bPeeringConsumerIdPrefixesPutResponse": { "type": "object", "properties": { "consumerActiviyId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerCustomerIdConsumerDetailsGetResponse": { "type": "object", "properties": { "consumerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "consumerName": { "type": "string", "example": "example string" }, "emails": { "type": "array", "items": { "type": "string", "example": "example string" } }, "globalObjectDeviceSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "globalObjectSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2GlobalObjectServiceSummaries" } }, "ipsecTunnelConfig": { "type": "array", "items": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerCustomerIdConsumerDetailsGetResponseIpsecVpnTunnelConfig" } }, "matchDetails": { "$ref": "#/components/schemas/manaV2B2bExtranetServiceCustomerMatchDetails" }, "peerType": { "type": "string", "example": "ENUM_VALUE" }, "policy": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetPeeringServiceConsumerLanSegmentPolicy" } }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } }, "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2GuestConsumerSiteToSiteVpnConfig" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bPeeringConsumerCustomerIdConsumerDetailsGetResponseIpsecVpnTunnelConfig": { "type": "object", "properties": { "bgpGraphiantAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpLocalAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborHoldTime": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborIpv4": { "type": "string", "example": "example string" }, "bgpNeighborIpv6": { "type": "string", "example": "example string" }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dpdRetries": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "graphiantDestinationIp": { "type": "string", "example": "example string" }, "graphiantIkeId": { "type": "string", "example": "example string" }, "graphiantOuterTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIpv6": { "type": "string", "example": "example string" }, "ikeAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ikeAuthenticationMethod": { "type": "string", "example": "example string" }, "ikeDhAlgorithm": { "type": "string", "example": "example string" }, "ikeEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ikeLifetime": { "type": "string", "example": "example string" }, "ikePresharedKey": { "type": "string", "example": "example string" }, "ikeVersion": { "type": "integer", "format": "int32", "example": 123 }, "ipsecAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ipsecEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ipsecExtendedSequenceNumber": { "type": "boolean", "example": true }, "ipsecLifetime": { "type": "string", "example": "example string" }, "ipsecMode": { "type": "string", "example": "example string" }, "ipsecPfsAlgorithm": { "type": "string", "example": "example string" }, "ipsecProtocol": { "type": "string", "example": "example string" }, "localIkeId": { "type": "string", "example": "example string" }, "localOuterTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIpv6": { "type": "string", "example": "example string" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnelMtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1ExtranetsB2bConsumerPostRequest": { "type": "object", "properties": { "policy": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetConsumerLanSegmentPolicy" } }, "providerEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false }, "manaV2ExtranetConsumerLanSegmentPolicy": { "type": "object", "properties": { "consumerLanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "restrictedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetConsumerNatRule" } } }, "additionalProperties": false }, "manaV2ExtranetConsumerNatRule": { "type": "object", "properties": { "outsideNatPrefix": { "type": "string", "example": "example string", "description": "Optional nat prefix associated with a service prefix with an empty string indicating no NATing" }, "servicePrefix": { "type": "string", "example": "10.1.2.0/24", "description": "Service prefix for the NAT rule (required)" } }, "additionalProperties": false, "required": [ "servicePrefix" ] }, "v1ExtranetsB2bConsumerPostResponse": { "type": "object", "properties": { "device": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ConsumerDeviceInformation" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetConsumerLanSegmentPolicyResponse" } }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false }, "manaV2ConsumerDeviceInformation": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "lastUpdated": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "site": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2ExtranetConsumerLanSegmentPolicyResponse": { "type": "object", "properties": { "consumerLanSegment": { "type": "integer", "format": "int64", "example": 1234567891011 }, "inboundSecurityRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRule" } }, "outboundSecurityRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRule" } }, "restrictedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetConsumerNatRule" } }, "trafficRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2TrafficPolicyRule" } } }, "additionalProperties": false }, "v1ExtranetsB2bConsumerIdGetResponse": { "type": "object", "properties": { "consumerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "policy": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ExtranetConsumerLanSegmentPolicyResponse" } }, "serviceName": { "type": "string", "example": "example string" }, "siteInformation": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bSiteInformation" } } }, "additionalProperties": false }, "v1ExtranetsB2bConsumerIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1ExtranetsB2bConsumerSummaryGetResponse": { "type": "object", "properties": { "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetConsumersSummary" } } }, "additionalProperties": false }, "manaV2B2bExtranetConsumersSummary": { "type": "object", "properties": { "b2bStatus": { "type": "string", "example": "ENUM_VALUE" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "numEdges": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numSegments": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numSites": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "providerName": { "type": "string", "example": "example string" }, "publisherName": { "type": "string", "example": "example string" }, "serviceName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsB2bConsumerDeviceStatusIdGetResponse": { "type": "object", "properties": { "serviceStatus": { "type": "string", "example": "ENUM_VALUE" }, "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2B2bExtranetStatusSummary" } } }, "additionalProperties": false }, "v1ExtranetsB2bCustomerInfoIdGetResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "providerEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "serviceName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1ExtranetsMonitoringNatUsageGetResponse": { "type": "object", "properties": { "allocatedCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/v1ExtranetsMonitoringNatUsageGetResponseAllocation" } }, "usageCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1ExtranetsMonitoringNatUsageGetResponseAllocation": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostname": { "type": "string", "example": "example string" }, "ipAddress": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsMonitoringLanSegmentsGetResponse": { "type": "object", "properties": { "vrfs": { "type": "array", "items": { "$ref": "#/components/schemas/v1ExtranetsMonitoringLanSegmentsGetResponseVrf" } } }, "additionalProperties": false }, "v1ExtranetsMonitoringLanSegmentsGetResponseVrf": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ExtranetsMonitoringTrafficSecurityPolicyPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isProvider": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1ExtranetsMonitoringTrafficSecurityPolicyPostResponse": { "type": "object", "properties": { "securityRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRuleRow" } }, "trafficRules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2TrafficPolicyRuleRow" } } }, "additionalProperties": false }, "manaV2SecurityPolicyRuleRow": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/manaV2SiteDeviceStub" }, "securityPolicyRule": { "$ref": "#/components/schemas/manaV2SecurityPolicyRule" }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2TrafficPolicyRuleRow": { "type": "object", "properties": { "device": { "$ref": "#/components/schemas/manaV2SiteDeviceStub" }, "trafficPolicyRule": { "$ref": "#/components/schemas/manaV2TrafficPolicyRule" }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2ExtranetsMonitoringConsumersPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v2ExtranetsMonitoringConsumersPostResponse": { "type": "object", "properties": { "consumers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Consumer" } } }, "additionalProperties": false }, "manaV2Consumer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "vrfs": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1PvifPostRequest": { "type": "object", "properties": { "advertisement": { "$ref": "#/components/schemas/manaV2SiteInformation" }, "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PublicVifGatewayConsumerLanDevices" } }, "coveringPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes monitored for this service; empty means 0.0.0.0/0" } }, "gatewayBgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2BgpNeighborConfig" } }, "lanSegmentId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer LAN segment (VRF) on gateway appliances (required)" }, "natPrefixStrategy": { "$ref": "#/components/schemas/manaV2PublicVifGatewayNatPrefixStrategy" }, "regionId": { "type": "integer", "format": "int32", "example": 123, "description": "Graphiant region for gateway appliances (required)" }, "serviceName": { "type": "string", "example": "example string", "description": "Service display name (required)" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Storage provider; each gateway appliance must match region and provider (required)" } }, "additionalProperties": false, "required": [ "consumerLanSegments", "gatewayBgpNeighbors", "lanSegmentId", "natPrefixStrategy", "regionId", "serviceName", "storageProvider" ] }, "manaV2SiteInformation": { "type": "object", "properties": { "siteLists": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "sites": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "manaV2PublicVifGatewayConsumerLanDevices": { "type": "object", "properties": { "consumerPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Allow prefixes for this consumer LAN; empty means 0.0.0.0/0" } } }, "additionalProperties": false }, "manaV2PublicVifGatewayNatPrefixStrategy": { "type": "object", "properties": { "centralized": { "$ref": "#/components/schemas/manaV2PublicVifGatewayCentralizedNat" }, "decentralized": { "$ref": "#/components/schemas/manaV2PublicVifGatewayDecentralizedPrefixes" } }, "additionalProperties": false }, "manaV2PublicVifGatewayCentralizedNat": { "type": "object", "properties": { "consumerPrefix": { "type": "object", "additionalProperties": { "type": "string", "example": "example string" } } }, "additionalProperties": false, "required": [ "consumerPrefix" ] }, "manaV2PublicVifGatewayDecentralizedPrefixes": { "type": "object", "properties": { "prefixes": { "type": "object", "additionalProperties": { "type": "string", "example": "example string" } } }, "additionalProperties": false, "required": [ "prefixes" ] }, "v1PvifPostResponse": { "type": "object", "properties": { "advertiseAllSites": { "type": "boolean", "example": true, "description": "True when consumer scope is all symmetric sites (snapshotted on create and update); false when advertisement lists explicit sites or site lists" }, "advertisement": { "$ref": "#/components/schemas/manaV2SiteInformation" }, "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PublicVifGatewayConsumerLanDevices" } }, "coveringPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes monitored for this service" } }, "gatewayBgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2BgpNeighbor" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id" }, "lanSegmentId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer LAN segment (VRF) id" }, "natPrefixStrategy": { "$ref": "#/components/schemas/manaV2PublicVifGatewayNatPrefixStrategy" }, "regionId": { "type": "integer", "format": "int32", "example": 123, "description": "Graphiant region for gateway appliances" }, "serviceName": { "type": "string", "example": "example string", "description": "Service display name" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Storage provider for gateway appliances" } }, "additionalProperties": false }, "v1PvifIdPutRequest": { "type": "object", "properties": { "configuration": { "$ref": "#/components/schemas/manaV2PublicVifGatewayWriteRequest" } }, "additionalProperties": false, "required": [ "configuration" ] }, "manaV2PublicVifGatewayWriteRequest": { "type": "object", "properties": { "advertisement": { "$ref": "#/components/schemas/manaV2SiteInformation" }, "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PublicVifGatewayConsumerLanDevices" } }, "coveringPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes monitored for this service; empty means 0.0.0.0/0" } }, "gatewayBgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2BgpNeighborConfig" } }, "lanSegmentId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer LAN segment (VRF) on gateway appliances (required)" }, "natPrefixStrategy": { "$ref": "#/components/schemas/manaV2PublicVifGatewayNatPrefixStrategy" }, "regionId": { "type": "integer", "format": "int32", "example": 123, "description": "Graphiant region for gateway appliances (required)" }, "serviceName": { "type": "string", "example": "example string", "description": "Service display name (required)" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Storage provider; each gateway appliance must match region and provider (required)" } }, "additionalProperties": false, "required": [ "consumerLanSegments", "gatewayBgpNeighbors", "lanSegmentId", "natPrefixStrategy", "regionId", "serviceName", "storageProvider" ] }, "v1PvifIdPutResponse": { "type": "object", "properties": { "advertiseAllSites": { "type": "boolean", "example": true, "description": "True when consumer scope is all symmetric sites (snapshotted on create and update); false when advertisement lists explicit sites or site lists" }, "advertisement": { "$ref": "#/components/schemas/manaV2SiteInformation" }, "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PublicVifGatewayConsumerLanDevices" } }, "coveringPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes monitored for this service" } }, "gatewayBgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2BgpNeighbor" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id" }, "lanSegmentId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer LAN segment (VRF) id" }, "natPrefixStrategy": { "$ref": "#/components/schemas/manaV2PublicVifGatewayNatPrefixStrategy" }, "regionId": { "type": "integer", "format": "int32", "example": 123, "description": "Graphiant region for gateway appliances" }, "serviceName": { "type": "string", "example": "example string", "description": "Service display name" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Storage provider for gateway appliances" } }, "additionalProperties": false }, "v1PvifIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1PvifIdDetailsGetResponse": { "type": "object", "properties": { "advertiseAllSites": { "type": "boolean", "example": true, "description": "True when consumer scope is all symmetric sites (snapshotted on create and update); false when advertisement lists explicit sites or site lists" }, "advertisement": { "$ref": "#/components/schemas/manaV2SiteInformation" }, "consumerLanSegments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2PublicVifGatewayConsumerLanDevices" } }, "coveringPrefixes": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Prefixes monitored for this service" } }, "gatewayBgpNeighbors": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2BgpNeighbor" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer service id" }, "lanSegmentId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Producer LAN segment (VRF) id" }, "natPrefixStrategy": { "$ref": "#/components/schemas/manaV2PublicVifGatewayNatPrefixStrategy" }, "regionId": { "type": "integer", "format": "int32", "example": 123, "description": "Graphiant region for gateway appliances" }, "serviceName": { "type": "string", "example": "example string", "description": "Service display name" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Storage provider for gateway appliances" } }, "additionalProperties": false }, "v1PvifSummaryGetResponse": { "type": "object", "properties": { "summary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PublicVifSummary" } } }, "additionalProperties": false }, "manaV2PublicVifSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "id of this Public VIF" }, "serviceName": { "type": "string", "example": "example string", "description": "name of this Public VIF" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "userName": { "type": "string", "example": "example string", "description": "creator of this Public VIF" } }, "additionalProperties": false }, "v1DevicesDeviceIdInterfacesGetResponse": { "type": "object", "properties": { "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Interface" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" } }, "additionalProperties": false }, "v1DevicesDeviceIdTwampCoreGetResponse": { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DevicesDeviceIdSlicePeersGetResponse": { "type": "object", "properties": { "slices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NetworkSlice" } } }, "additionalProperties": false }, "manaV2NetworkSlice": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "example": 123 }, "peers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2NetworkSlicePeer" } }, "sliceIndex": { "type": "integer", "format": "int32", "example": 123 }, "tags": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2NetworkSlicePeer": { "type": "object", "properties": { "bgpConnection": { "$ref": "#/components/schemas/manaV2BgpConnection" }, "connectionQuality": { "type": "string", "example": "ENUM_VALUE" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "gdi": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "hostname": { "type": "string", "example": "example string" }, "ipsecConnection": { "$ref": "#/components/schemas/manaV2InterfaceTunnel" }, "state": { "type": "string", "example": "example string" }, "wanAddresses": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "manaV2BgpConnection": { "type": "object", "properties": { "localAddress": { "type": "string", "example": "example string" }, "operStatus": { "type": "boolean", "example": true }, "remoteAddress": { "type": "string", "example": "example string" }, "state": { "type": "string", "example": "ENUM_VALUE" }, "timeSinceLastOperChange": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "up": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2InterfaceTunnel": { "type": "object", "properties": { "antiReplayWSize": { "type": "integer", "format": "int32", "example": 123 }, "establishedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "localCircuit": { "type": "string", "example": "example string" }, "localInterface": { "$ref": "#/components/schemas/manaV2Interface" }, "localPort": { "type": "integer", "format": "int32", "example": 123 }, "localSpi": { "type": "integer", "format": "int64", "example": 1234567891011 }, "negotiatedAlgorithms": { "type": "string", "example": "example string" }, "operState": { "type": "boolean", "example": true }, "peerAddress": { "type": "string", "example": "example string" }, "protocol": { "type": "string", "example": "example string" }, "rekeyTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "remotePort": { "type": "integer", "format": "int32", "example": 123 }, "remoteSpi": { "type": "integer", "format": "int64", "example": 1234567891011 }, "sessionId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "sourceAddress": { "type": "string", "example": "example string" }, "tunnelInterface": { "$ref": "#/components/schemas/manaV2Interface" } }, "additionalProperties": false }, "v1DevicesDeviceIdOspfv2DefaultOriginateGetResponse": { "type": "object", "properties": { "defaultOriginates": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "v1DevicesDeviceIdOspfv3DefaultOriginateGetResponse": { "type": "object", "properties": { "defaultOriginates": { "type": "object", "additionalProperties": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "v1DevicesDeviceIdVrfProtocolsGetResponse": { "type": "object", "properties": { "bgp": { "type": "boolean", "example": true }, "connected": { "type": "boolean", "example": true }, "graphiant": { "type": "boolean", "example": true }, "ospfv2": { "type": "boolean", "example": true }, "ospfv3": { "type": "boolean", "example": true }, "static": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1PolicyRouteTagSetsPostRequest": { "type": "object", "properties": { "tag": { "$ref": "#/components/schemas/manaV2RouteTag" } }, "additionalProperties": false }, "v1PolicyRouteTagSetsPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1PolicyRouteTagSetsIdDeleteResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1PolicyRouteTagSetsTagsGetResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RouteTagElement" } } }, "additionalProperties": false }, "manaV2RouteTagElement": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "nextSet": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RouteTagElement" } }, "tag": { "type": "string", "example": "example string" }, "tagValue": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1PolicyRouteTagSetsTagsSummaryGetResponse": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RouteTagSummary" } } }, "additionalProperties": false }, "manaV2RouteTagSummary": { "type": "object", "properties": { "deviceCount": { "type": "integer", "format": "int32", "example": 123 }, "levelOne": { "type": "integer", "format": "int64", "example": 1234567891011 }, "levelOneTag": { "type": "string", "example": "example string" }, "levelTwo": { "type": "integer", "format": "int64", "example": 1234567891011 }, "levelTwoTag": { "type": "string", "example": "example string" }, "levelZero": { "type": "integer", "format": "int64", "example": 1234567891011 }, "levelZeroTag": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2RouteTagId": { "type": "object", "properties": { "levelOne": { "type": "integer", "format": "int64", "example": 1234567891011 }, "levelTwo": { "type": "integer", "format": "int64", "example": 1234567891011 }, "levelZero": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1PolicyRouteTagSetsTagDetailGetResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RouteTagDevice" } } }, "additionalProperties": false }, "manaV2RouteTagDevice": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "locationId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "tag": { "$ref": "#/components/schemas/manaV2RouteTag" } }, "additionalProperties": false }, "v1PolicyApplicationsGetResponse": { "type": "object", "properties": { "applications": { "type": "array", "items": { "$ref": "#/components/schemas/v1PolicyApplicationsGetResponseApplication" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" } }, "additionalProperties": false }, "v1PolicyApplicationsGetResponseApplication": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "description": { "type": "string", "example": "example string" }, "kind": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdPolicyApplicationsGetResponse": { "type": "object", "properties": { "applications": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesDeviceIdPolicyApplicationsGetResponseApplication" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" } }, "additionalProperties": false }, "v1DevicesDeviceIdPolicyApplicationsGetResponseApplication": { "type": "object", "properties": { "appId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "description": { "type": "string", "example": "example string" }, "kind": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdPolicyZonepairsGetResponse": { "type": "object", "properties": { "zonePairs": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2FirewallZonePair" } } }, "additionalProperties": false }, "manaV2FirewallZonePair": { "type": "object", "properties": { "inside": { "type": "string", "example": "example string" }, "outside": { "type": "string", "example": "example string" }, "securityRulesets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SecurityPolicyRuleset" } } }, "additionalProperties": false }, "v1SitesGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Site" } } }, "additionalProperties": false }, "v1SitesPostRequest": { "type": "object", "properties": { "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "site": { "$ref": "#/components/schemas/manaV2NewSite" } }, "additionalProperties": false }, "v1SitesPostResponse": { "type": "object", "properties": { "site": { "$ref": "#/components/schemas/manaV2Site" } }, "additionalProperties": false }, "v1SitesSiteIdPostRequest": { "type": "object", "properties": { "site": { "$ref": "#/components/schemas/manaV2NewSite" } }, "additionalProperties": false }, "v1SitesSiteIdPostResponse": { "type": "object", "properties": { "site": { "$ref": "#/components/schemas/manaV2Site" } }, "additionalProperties": false }, "v1SitesSiteIdCircuitsGetResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v1SitesSiteIdCircuitsGetResponseData" } } }, "additionalProperties": false }, "v1SitesSiteIdCircuitsGetResponseData": { "type": "object", "properties": { "circuits": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Circuit" } }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "v1SitesSiteIdDevicesGetResponse": { "type": "object", "properties": { "device": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2topology_device" } } }, "additionalProperties": false }, "manaV2topology_device": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "hostname": { "type": "string", "example": "example string" }, "location": { "type": "string", "example": "example string" }, "maintenanceMode": { "type": "boolean", "example": true }, "managementIp": { "type": "string", "example": "example string" }, "model": { "type": "string", "example": "example string" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "serialNumber": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "softwareVersion": { "type": "string", "example": "example string" }, "stagingMode": { "type": "boolean", "example": true }, "uptime": { "$ref": "#/components/schemas/googleProtobufDuration" }, "vrrpInterface": { "type": "string", "example": "example string" }, "vrrpState": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1SitesMapDetailsGetResponse": { "type": "object", "properties": { "lanSegmentIds": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2LanSegmentSitesMap" } } }, "additionalProperties": false }, "manaV2LanSegmentSitesMap": { "type": "object", "properties": { "siteIds": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2SiteLanSegmentDeviceBuckets" } }, "siteListIds": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2SiteLanSegmentDeviceBuckets" } } }, "additionalProperties": false }, "manaV2SiteLanSegmentDeviceBuckets": { "type": "object", "properties": { "lanSegmentExists": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteDeviceSummary" } }, "lanSegmentMissing": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteDeviceSummary" } } }, "additionalProperties": false }, "manaV2SiteDeviceSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "hostname": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1LanSegmentsInterfacesPublicGetResponse": { "type": "object", "properties": { "lanSegmentIds": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2LanSegmentPublicInterfacesLists" } } }, "additionalProperties": false }, "manaV2LanSegmentPublicInterfacesLists": { "type": "object", "properties": { "privateInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2LanSegmentPublicInterfaceEntry" } }, "publicInterfaces": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2LanSegmentPublicInterfaceEntry" } } }, "additionalProperties": false }, "manaV2LanSegmentPublicInterfaceEntry": { "type": "object", "properties": { "interfaceId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "network.interface id (required)" }, "ipv4Addresses": { "type": "array", "items": { "type": "string", "example": "example string", "description": "IPv4 host/prefix strings from interface_ip_address (non-stale rows)" } }, "name": { "type": "string", "example": "example string", "description": "Device interface name (BGP local_interface uses this) (required)" }, "storageProvider": { "type": "string", "example": "ENUM_VALUE", "description": "Interface storage provider (cloud provider for gateway LAN interfaces)" } }, "additionalProperties": false }, "v1RegionsGetResponse": { "type": "object", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Region" } } }, "additionalProperties": false }, "v1RegionsRegionIdGatewaysGetResponse": { "type": "object", "properties": { "gateways": { "type": "array", "items": { "$ref": "#/components/schemas/v1RegionsRegionIdGatewaysGetResponseGateway" } } }, "additionalProperties": false }, "v1RegionsRegionIdGatewaysGetResponseGateway": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostname": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1LanSegmentsGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Vrf" } } }, "additionalProperties": false }, "v1QosCircuitProfilesGetResponse": { "type": "object", "properties": { "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2QoSProfile" } } }, "additionalProperties": false }, "v1DevicesDeviceIdCandidateCircuitsGetResponse": { "type": "object", "properties": { "circuits": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesDeviceIdCandidateCircuitsGetResponseCircuitInfo" } } }, "additionalProperties": false }, "v1DevicesDeviceIdCandidateCircuitsGetResponseCircuitInfo": { "type": "object", "properties": { "circuit": { "type": "string", "example": "example string" }, "interface": { "type": "string", "example": "example string" }, "loopbackInterface": { "type": "string", "example": "example string" }, "vrf": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdCircuitsVrfAssociationsGetResponse": { "type": "object", "properties": { "vrfAssociations": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/v1DevicesDeviceIdCircuitsVrfAssociationsGetResponseVrfAssociations" } } }, "additionalProperties": false }, "v1DevicesDeviceIdCircuitsVrfAssociationsGetResponseVrfAssociations": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "loopbackInterfaceName": { "type": "string", "example": "example string" }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1LldpInterfaceIdSummaryGetResponse": { "type": "object", "properties": { "numNeighbors": { "type": "integer", "format": "int64", "example": 1234567891011 }, "numVendors": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1LldpInterfaceIdVendorsGetResponse": { "type": "object", "properties": { "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2VendorDetail" } } }, "additionalProperties": false }, "manaV2VendorDetail": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "neighborCount": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1LldpInterfaceIdNeighborsGetResponse": { "type": "object", "properties": { "neighbors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2LldpNeighbor" } } }, "additionalProperties": false }, "manaV2LldpNeighbor": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interface": { "type": "string", "example": "example string" }, "ipAddress": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" }, "port": { "type": "string", "example": "example string" }, "systemName": { "type": "string", "example": "example string" }, "vendor": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1ZonesGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Zone" } } }, "additionalProperties": false }, "manaV2Zone": { "type": "object", "properties": { "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesDeviceIdVersionsGetResponse": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2VersionMetadata" } } }, "additionalProperties": false }, "manaV2VersionMetadata": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "version": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1DevicesDeviceIdVersionsVersionGetResponse": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2ManaConfiguration" } }, "additionalProperties": false }, "manaV2ManaConfiguration": { "type": "object", "properties": { "manaDevice": { "$ref": "#/components/schemas/manaV2Device" }, "versionInfo": { "$ref": "#/components/schemas/manaV2VersionMetadata" } }, "additionalProperties": false }, "v1DevicesDeviceIdDraftPostRequest": { "type": "object", "properties": { "baseVersion": { "type": "integer", "format": "int32", "example": 123 }, "description": { "type": "string", "example": "example string" }, "draft": { "$ref": "#/components/schemas/manaV2Device" } }, "additionalProperties": false }, "v1DevicesDeviceIdDraftPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1DevicesDeviceIdDraftGetResponse": { "type": "object", "properties": { "draft": { "$ref": "#/components/schemas/manaV2ManaConfiguration" } }, "additionalProperties": false }, "v1VersionPostRequest": { "type": "object", "properties": { "configurationMetadata": { "$ref": "#/components/schemas/manaV2ConfigurationMetadata" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "version": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1VersionPostResponse": { "type": "object", "properties": { "updatedVersion": { "$ref": "#/components/schemas/manaV2VersionMetadata" } }, "additionalProperties": false }, "v1GatewaysSummaryGetResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GatewaySummary" } } }, "additionalProperties": false }, "manaV2GatewaySummary": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "gatewayDeviceSummary": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GatewaySummaryGatewayDeviceSummary" } }, "graphiantRegion": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "speed": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "supportStatus": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "manaV2GatewaySummaryGatewayDeviceSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostname": { "type": "string", "example": "example string" }, "interfaceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "maintenanceMode": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1GatewaysStatusPostRequest": { "type": "object", "properties": { "deviceInfo": { "type": "array", "items": { "$ref": "#/components/schemas/v1GatewaysStatusPostRequestDeviceInfo" } }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" }, "supportStatus": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GatewaysStatusPostRequestDeviceInfo": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaceId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1GatewaysStatusPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GatewaysRegionsGetResponse": { "type": "object", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Region" } } }, "additionalProperties": false }, "v1GatewaysPostRequest": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/manaV2GatewayDetails" } }, "additionalProperties": false }, "manaV2GatewayDetails": { "type": "object", "properties": { "aws": { "$ref": "#/components/schemas/manaV2AwsGatewayDetails" }, "azure": { "$ref": "#/components/schemas/manaV2AzureGatewayDetails" }, "description": { "type": "string", "example": "example string" }, "gcp": { "$ref": "#/components/schemas/manaV2GcpGatewayDetails" }, "ipsecGateway": { "$ref": "#/components/schemas/manaV2IPsecGatewayDetails" }, "ipsecGatewayPeers": { "$ref": "#/components/schemas/manaV2IPsecGatewayPeersConfig" }, "oci": { "$ref": "#/components/schemas/manaV2OciGatewayDetails" }, "regionId": { "type": "integer", "format": "int32", "example": 123 }, "speed": { "type": "string", "example": "ENUM_VALUE" }, "vrfId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "manaV2AwsGatewayDetails": { "type": "object", "properties": { "accountId": { "type": "string", "example": "example string" }, "advanceSettings": { "$ref": "#/components/schemas/manaV2AwsAdvanceSettings" }, "transitConnection": { "$ref": "#/components/schemas/manaV2AWSGatewayDetailsTransitConnection" } }, "additionalProperties": false }, "manaV2AwsAdvanceSettings": { "type": "object", "properties": { "addressFamily": { "type": "string", "example": "ENUM_VALUE" }, "allowedPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "amazonBgpRouterIp": { "type": "string", "example": "example string" }, "bgpAuthKey": { "type": "string", "example": "example string" }, "customerBgpRouterIp": { "type": "string", "example": "example string" }, "isJumbo": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2AWSGatewayDetailsTransitConnection": { "type": "object", "properties": { "credentials": { "$ref": "#/components/schemas/manaV2AwsCredentials" }, "customerAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "gateway": { "$ref": "#/components/schemas/manaV2AwsDirectConnectGateway" }, "region": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2AwsCredentials": { "type": "object", "properties": { "accessKeyId": { "type": "string", "example": "example string" }, "secretAccessKey": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2AwsDirectConnectGateway": { "type": "object", "properties": { "asn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "transitGateways": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2AwsTransitGateway" } } }, "additionalProperties": false }, "manaV2AwsTransitGateway": { "type": "object", "properties": { "asn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "string", "example": "example string" }, "vpcs": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2AWSTransitGatewayVpc" } } }, "additionalProperties": false }, "manaV2AWSTransitGatewayVpc": { "type": "object", "properties": { "id": { "type": "string", "example": "example string" }, "subnets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Subnet" } } }, "additionalProperties": false }, "manaV2Subnet": { "type": "object", "properties": { "cidr": { "type": "string", "example": "example string" }, "id": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2AzureGatewayDetails": { "type": "object", "properties": { "msPeeringVlanId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "routingPolicy": { "type": "string", "example": "example string" }, "serviceKey": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2GcpGatewayDetails": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "pairingKey": { "type": "string", "example": "example string" }, "routingPolicy": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2OciGatewayDetails": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "fastConnectOcid": { "type": "string", "example": "example string" }, "routingPolicy": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GatewaysPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1GatewaysIdDetailsGetResponse": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/manaV2GatewayDetails" } }, "additionalProperties": false }, "v1GatewaysPutRequest": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/manaV2GatewayDetails" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1GatewaysPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GatewaysDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GatewaysGuestConsumerMatchIdGetResponse": { "type": "object", "properties": { "destinationPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ipsecTunnelConfig": { "type": "array", "items": { "$ref": "#/components/schemas/v1GatewaysGuestConsumerMatchIdGetResponseIpsecVpnTunnelConfig" } }, "siteToSiteVpn": { "$ref": "#/components/schemas/manaV2GuestConsumerSiteToSiteVpnConfig" } }, "additionalProperties": false }, "v1GatewaysGuestConsumerMatchIdGetResponseIpsecVpnTunnelConfig": { "type": "object", "properties": { "bgpGraphiantAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpLocalAsn": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborHoldTime": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bgpNeighborIpv4": { "type": "string", "example": "example string" }, "bgpNeighborIpv6": { "type": "string", "example": "example string" }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dpdRetries": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "graphiantDestinationIp": { "type": "string", "example": "example string" }, "graphiantIkeId": { "type": "string", "example": "example string" }, "graphiantOuterTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIp": { "type": "string", "example": "example string" }, "graphiantTunnelIpv6": { "type": "string", "example": "example string" }, "ikeAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ikeAuthenticationMethod": { "type": "string", "example": "example string" }, "ikeDhAlgorithm": { "type": "string", "example": "example string" }, "ikeEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ikeLifetime": { "type": "string", "example": "example string" }, "ikePresharedKey": { "type": "string", "example": "example string" }, "ikeVersion": { "type": "integer", "format": "int32", "example": 123 }, "ipsecAuthenticationAlgorithm": { "type": "string", "example": "example string" }, "ipsecEncryptionAlgorithm": { "type": "string", "example": "example string" }, "ipsecExtendedSequenceNumber": { "type": "boolean", "example": true }, "ipsecLifetime": { "type": "string", "example": "example string" }, "ipsecMode": { "type": "string", "example": "example string" }, "ipsecPfsAlgorithm": { "type": "string", "example": "example string" }, "ipsecProtocol": { "type": "string", "example": "example string" }, "localIkeId": { "type": "string", "example": "example string" }, "localOuterTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIp": { "type": "string", "example": "example string" }, "localTunnelIpv6": { "type": "string", "example": "example string" }, "tcpMss": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tunnelMtu": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1GatewaysReferenceConsumerGetResponse": { "type": "object", "properties": { "ipsecGatewayDetails": { "$ref": "#/components/schemas/manaV2IPsecGatewayDetails" }, "ipsecGatewayPeers": { "$ref": "#/components/schemas/manaV2IPsecGatewayPeersConfig" } }, "additionalProperties": false }, "v1SitesDetailsGetResponse": { "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Site" } } }, "additionalProperties": false }, "v1SiteDetailsSitelistsPostRequest": { "type": "object", "properties": { "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1SiteDetailsSitelistsPostResponse": { "type": "object", "properties": { "siteLists": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteList" } } }, "additionalProperties": false }, "manaV2SiteList": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "policyCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "siteCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "siteListId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1SiteIdDetailsInterfacesGetResponse": { "type": "object", "properties": { "interfaces": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1GlobalConfigPatchRequest": { "type": "object", "properties": { "globalPrefixSets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullablePrefixSetConfig" } }, "ipfixExporters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIpfixExporterConfig" } }, "ntps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableNtpConfig" } }, "prefixSets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableEnterprisePrefixSetConfig" } }, "routingPolicies": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableRoutingPolicyConfig" } }, "snmps": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSnmpConfig" } }, "syslogServers": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableSyslogCollectorConfig" } }, "trafficPolicies": { "$ref": "#/components/schemas/manaV2ForwardingPolicyConfig" }, "vpnProfiles": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2NullableIPsecVpnProfilesConfig" } } }, "additionalProperties": false }, "manaV2NullableEnterprisePrefixSetConfig": { "type": "object", "properties": { "target": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetConfig" } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetConfig": { "type": "object", "properties": { "prefixSet": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetData" } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetData": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2EnterprisePrefixSetDataEntry" } }, "mode": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "manaV2EnterprisePrefixSetDataEntry": { "type": "object", "properties": { "ipPrefix": { "type": "string", "example": "example string" }, "maskLower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "maskUpper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "seq": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "manaV2NullableIPsecVpnProfilesConfig": { "type": "object", "properties": { "vpnProfile": { "$ref": "#/components/schemas/manaV2IPsecProfile" } }, "additionalProperties": false }, "manaV2IPsecProfile": { "type": "object", "properties": { "antiReplayWindowSize": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "dpdInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "esn": { "type": "boolean", "example": true }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ikeDhGroup": { "type": "string", "example": "ENUM_VALUE" }, "ikeEncryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "ikeIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "ipsecEncryptionAlg": { "type": "string", "example": "ENUM_VALUE" }, "ipsecIntegrity": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "perfectForwardSecrecy": { "type": "string", "example": "ENUM_VALUE" }, "reauthInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "rekeyInterval": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1GlobalConfigPatchResponse": { "type": "object", "properties": { "globalPrefixSets": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "ipfixExporters": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "ntps": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "prefixSets": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "routingPolicies": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "snmps": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "status": { "type": "string", "example": "example string" }, "syslogServers": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "trafficPolicies": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "vpnProfiles": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalLanSegmentsPostRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalLanSegmentsPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalLanSegmentsGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalLanSegmentsGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalLanSegmentsGetResponseEntry": { "type": "object", "properties": { "associatedInterfaces": { "type": "integer", "format": "int32", "example": 123 }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "description": { "type": "string", "example": "example string" }, "edgeReferences": { "type": "integer", "format": "int32", "example": 123 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "siteListReferences": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1GlobalLanSegmentsVrfIdDevicesGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalLanSegmentsVrfIdDevicesGetResponseEntry" } }, "status": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalLanSegmentsVrfIdDevicesGetResponseEntry": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostName": { "type": "string", "example": "example string" }, "numInterfaces": { "type": "integer", "format": "int32", "example": 123 }, "site": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1GlobalSiteListsPostRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteListEntry" } }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2SiteListEntry": { "type": "object", "properties": { "regular": { "type": "integer", "format": "int64", "example": 1234567891011 }, "tag": { "$ref": "#/components/schemas/manaV2RouteTagId" } }, "additionalProperties": false }, "v1GlobalSiteListsPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalSiteListsIdPutRequest": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteListEntry" } } }, "additionalProperties": false }, "v1GlobalSiteListsIdPutResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalSiteListsGetResponse": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalSiteListsGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalSiteListsGetResponseEntry": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "description": { "type": "string", "example": "example string" }, "edgeReferences": { "type": "integer", "format": "int32", "example": 123 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "policyReferences": { "type": "integer", "format": "int32", "example": 123 }, "siteListReferences": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1GlobalSiteListsIdGetResponse": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteListEntry" } } }, "additionalProperties": false }, "v1GlobalSiteListsIdSitesGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SiteListSiteEntry" } } }, "additionalProperties": false }, "manaV2SiteListSiteEntry": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "edgeReferences": { "type": "integer", "format": "int32", "example": 123 }, "siteName": { "type": "string", "example": "example string" }, "tag": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RouteTagId" } } }, "additionalProperties": false }, "v1GlobalSummaryPostRequest": { "type": "object", "properties": { "ipfixExportedType": { "type": "boolean", "example": true }, "ntpType": { "type": "boolean", "example": true }, "prefixSetType": { "type": "boolean", "example": true }, "routingPolicyType": { "type": "boolean", "example": true }, "snmpType": { "type": "boolean", "example": true }, "syslogServerType": { "type": "boolean", "example": true }, "trafficPolicyType": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1GlobalSummaryPostResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalObjectSummary" } } }, "additionalProperties": false }, "v1GlobalSiteStatusGetResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalObjectDeviceStatus" } } }, "additionalProperties": false }, "manaV2GlobalObjectDeviceStatus": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "errorMessage": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" }, "internalState": { "type": "string", "example": "ENUM_VALUE" }, "siteName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "statusSince": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1GlobalDeviceStatusGetResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalObjectDeviceStatus" } } }, "additionalProperties": false }, "v1GlobalSyncPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "ipfixExportedId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ntpId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "prefixSetId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "routingPolicyId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "snmpId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "syslogServerId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "trafficPolicyId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1GlobalSyncPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalAttachedEdgesPostRequest": { "type": "object", "properties": { "ipfixExportedIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "ntpIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "prefixSetIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "routingPolicyIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "snmpIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "syslogServerIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "trafficPolicyIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalAttachedEdgesPostResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalObjectDeviceStatus" } } }, "additionalProperties": false }, "v1GlobalSyslogsPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalSyslogsPostResponse": { "type": "object", "properties": { "collectors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SyslogCollector" } } }, "additionalProperties": false }, "v1GlobalSyslogsSiteGetResponse": { "type": "object", "properties": { "collectors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SyslogCollector" } } }, "additionalProperties": false }, "v1GlobalSyslogsDeviceGetResponse": { "type": "object", "properties": { "collectors": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2SyslogCollector" } } }, "additionalProperties": false }, "v1GlobalSnmpsPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalSnmpsPostResponse": { "type": "object", "properties": { "snmps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Snmp" } } }, "additionalProperties": false }, "v1GlobalSnmpsSiteGetResponse": { "type": "object", "properties": { "snmps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Snmp" } } }, "additionalProperties": false }, "v1GlobalSnmpsDeviceGetResponse": { "type": "object", "properties": { "snmps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Snmp" } } }, "additionalProperties": false }, "v1GlobalNtpsPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalNtpsPostResponse": { "type": "object", "properties": { "ntps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Ntp" } } }, "additionalProperties": false }, "v1GlobalNtpsSiteGetResponse": { "type": "object", "properties": { "ntps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Ntp" } } }, "additionalProperties": false }, "v1GlobalNtpsDeviceGetResponse": { "type": "object", "properties": { "ntps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2Ntp" } } }, "additionalProperties": false }, "v1GlobalPrefixSetsPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalPrefixSetsPostResponse": { "type": "object", "properties": { "prefixSets": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2PrefixSet" } } }, "additionalProperties": false }, "v1GlobalRoutingPoliciesPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalRoutingPoliciesPostResponse": { "type": "object", "properties": { "routingPolicies": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RoutingPolicy" } } }, "additionalProperties": false }, "v1GlobalTrafficPoliciesPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalTrafficPoliciesPostResponse": { "type": "object", "properties": { "trafficPolicy": { "$ref": "#/components/schemas/manaV2ForwardingPolicy" } }, "additionalProperties": false }, "v1GlobalIpfixPostRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1GlobalIpfixPostResponse": { "type": "object", "properties": { "exporters": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpfixExporter" } } }, "additionalProperties": false }, "v1GlobalIpfixSiteGetResponse": { "type": "object", "properties": { "exporters": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpfixExporter" } } }, "additionalProperties": false }, "v1GlobalIpfixDeviceGetResponse": { "type": "object", "properties": { "exporters": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2IpfixExporter" } } }, "additionalProperties": false }, "v1GlobalIpsecProfileGetResponse": { "type": "object", "properties": { "ipsecProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalIpsecProfileGetResponseIPsecProfileCount" } } }, "additionalProperties": false }, "v1GlobalIpsecProfileGetResponseIPsecProfileCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipsecProfileName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalIpsecProfileIdGetResponse": { "type": "object", "properties": { "ipsecProfile": { "$ref": "#/components/schemas/manaV2IPsecProfile" } }, "additionalProperties": false }, "v1GlobalIpsecProfileVpnProfileIdSiteToSiteGetResponse": { "type": "object", "properties": { "siteToSiteVpn": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalIpsecProfileVpnProfileIdSiteToSiteGetResponseSiteToSiteVpn" } } }, "additionalProperties": false }, "v1GlobalIpsecProfileVpnProfileIdSiteToSiteGetResponseSiteToSiteVpn": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1PresharedkeyGetResponse": { "type": "object", "properties": { "presharedkey": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GatewaysIpsecRegionsRegionIdVrfsVrfIdInsideSubnetGetResponse": { "type": "object", "properties": { "ipv4Subnet": { "type": "string", "example": "example string" }, "ipv6Subnet": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2TimePeriod": { "type": "object", "properties": { "month": { "type": "integer", "format": "int32", "example": 123 }, "year": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1EnterpriseAllocationGetResponse": { "type": "object", "properties": { "consumptionSummary": { "$ref": "#/components/schemas/manaV2BandwidthConsumptionSummary" }, "conversionHolders": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2AllocationConversionHolder" } }, "regionalAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2RegionalAllocation" } }, "zeroTrustSummary": { "$ref": "#/components/schemas/manaV2ZeroTrustConsumptionSummary" } }, "additionalProperties": false }, "manaV2BandwidthConsumptionSummary": { "type": "object", "properties": { "contractualSummary": { "$ref": "#/components/schemas/manaV2ContractualBandwidthConsumptionSummary" }, "globalSummary": { "$ref": "#/components/schemas/manaV2GlobalBandwidthConsumptionSummary" }, "regionalSummaries": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2RegionalBandwidthConsumptionSummary" } } }, "additionalProperties": false }, "manaV2ContractualBandwidthConsumptionSummary": { "type": "object", "properties": { "expirationDate": { "$ref": "#/components/schemas/manaV2TimePeriod" }, "totalConsumedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "All credits consumed over the entirety the enterprise's contracts" }, "totalContractedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Number of credits agreed upon for the entirety of the current contract" }, "totalRemainingCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Number of unused credits remaining under the current contract" } }, "additionalProperties": false }, "manaV2GlobalBandwidthConsumptionSummary": { "type": "object", "properties": { "allocatedMonthlyCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits allocated for the current month" }, "consumedMonthlyCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits billed for the current month. It equals the the higher value between the credits allocated and used for the month" }, "priorAllocatedMonthlyCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits allocated for the prior month" }, "priorConsumedMonthlyCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits billed for the prior month." }, "recommendedMonthlyCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Expected amount of credits to allocate for the month to match the overall contracted amount. For monthly-contracted enterprises, this is equivalent to the monthly number of credits being billed while for term-based-contracted enterprises, this is equivalent to the number of credits to use up in this and the following months to use up exactly the number of credits remaining in the contract." } }, "additionalProperties": false }, "manaV2RegionalBandwidthConsumptionSummary": { "type": "object", "properties": { "allocation": { "$ref": "#/components/schemas/manaV2BandwidthInfo" }, "consumedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits billed for the region. It equals the higher value between total credits allocated and used plus any additional dia consumption" }, "coreConversionFactor": { "type": "number", "format": "float", "example": 12.34, "description": "Conversion rate from gigabytes per second to Graphiant credits used for calculating credits on core networks for this region" }, "gwConversionFactor": { "type": "number", "format": "float", "example": 12.34, "description": "Conversion rate from gigabytes per second to Graphiant credits used for calculating credits on core networks for this region" }, "internetConsumption": { "$ref": "#/components/schemas/manaV2InternetAccessBandwidthInfo" }, "usage": { "$ref": "#/components/schemas/manaV2BandwidthInfo" } }, "additionalProperties": false }, "manaV2BandwidthInfo": { "type": "object", "properties": { "combinedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Sum of the credits associated with cloud and gateway networks" }, "coreBandwidth": { "type": "number", "format": "float", "example": 12.34, "description": "Soft-upper-bounded max speed in gigabytes per second associated with core network connections" }, "coreCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits derived from bandwidth on core network connections" }, "gwBandwidth": { "type": "number", "format": "float", "example": 12.34, "description": "Soft-upper-bounded max speed in gigabytes per second associated with gateway connections" }, "gwCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Credits derived from bandwidth on gateway network connections" } }, "additionalProperties": false }, "manaV2InternetAccessBandwidthInfo": { "type": "object", "properties": { "internetBandwidth": { "type": "number", "format": "float", "example": 12.34, "description": "Bandwidth value associated with dia gateways. This should either be 0, 10, or 100." }, "internetCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Additional credits to support the provided DIA bandwidth" } }, "additionalProperties": false }, "manaV2AllocationConversionHolder": { "type": "object", "properties": { "bins": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2AllocationConversionHolderBin" } } }, "additionalProperties": false }, "manaV2AllocationConversionHolderBin": { "type": "object", "properties": { "allocationUpperBound": { "type": "number", "format": "float", "example": 12.34, "description": "Int32 value indicating the conversion rates apply from the prior highest upper bound to this upper bound" }, "coreConversionFactor": { "type": "number", "format": "float", "example": 12.34, "description": "Conversion rate from gigabytes per second to Graphiant credits for connections to core devices" }, "coreConversionRate": { "type": "integer", "format": "int32", "example": 123 }, "gwConversionFactor": { "type": "number", "format": "float", "example": 12.34, "description": "Conversion rate from gigabytes per second to Graphiant credits for connections to gateway devices" }, "gwConversionRate": { "type": "integer", "format": "int32", "example": 123 }, "isPrivate": { "type": "boolean", "example": true, "description": "True-only flag indicating the conversion rates apply within a private context such as in-country" } }, "additionalProperties": false }, "manaV2RegionalAllocation": { "type": "object", "properties": { "allocationCore": { "type": "number", "format": "float", "example": 12.34, "description": "Gigabytes per second allowed for core network connections on this region" }, "allocationGw": { "type": "number", "format": "float", "example": 12.34, "description": "Gigabytes per second allowed for gateway connections on this region" }, "allocationInternet": { "type": "number", "format": "float", "example": 12.34, "description": "Gigabytes per second allowed for dia gateway internet access on this region. Must be 0, 10, or 100" }, "creditCore": { "type": "number", "format": "float", "example": 12.34 }, "creditGw": { "type": "number", "format": "float", "example": 12.34 }, "regionId": { "type": "integer", "format": "int32", "example": 123 }, "regionName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2ZeroTrustConsumptionSummary": { "type": "object", "properties": { "userAgentCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Number of devices that have been installed with the zero trust agent" } }, "additionalProperties": false }, "v1EnterpriseConfigurationPutRequest": { "type": "object", "properties": { "configuration": { "$ref": "#/components/schemas/manaV2EnterpriseConfiguration" } }, "additionalProperties": false }, "manaV2EnterpriseConfiguration": { "type": "object", "properties": { "encryption": { "type": "string", "example": "ENUM_VALUE" }, "useEncryption": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1EnterpriseConfigurationPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1EnterpriseConfigurationGetResponse": { "type": "object", "properties": { "configuration": { "$ref": "#/components/schemas/manaV2EnterpriseConfiguration" } }, "additionalProperties": false }, "v1EnterpriseContractPutRequest": { "type": "object", "properties": { "contractedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "Amount of credits billed for a contract term or per month when no expiration is provided. For an MSP tenant, this is the total credits in the MSP billing pool (from which credits are allocated to managed enterprises)." }, "expirationDate": { "$ref": "#/components/schemas/manaV2TimePeriod" } }, "additionalProperties": false }, "v1EnterpriseContractPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1MspManagedEnterpriseContractInfoGetResponse": { "type": "object", "properties": { "enterprises": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2ManagedEnterpriseContractInfo" } }, "mspConsumedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "All credits consumed by the MSP over the entirety of its contracts" }, "mspContract": { "$ref": "#/components/schemas/commonBillingContract" } }, "additionalProperties": false }, "manaV2ManagedEnterpriseContractInfo": { "type": "object", "properties": { "consumedCredits": { "type": "number", "format": "float", "example": 12.34, "description": "All credits consumed over the entirety the enterprise's contracts" }, "enterpriseContract": { "$ref": "#/components/schemas/commonBillingContract" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enterpriseName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DeviceSnapshotGetResponse": { "type": "object", "properties": { "firstSnapshot": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" }, "secondSnapshot": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" }, "thirdSnapshot": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" } }, "additionalProperties": false }, "manaV2DeviceSnapshot": { "type": "object", "properties": { "author": { "$ref": "#/components/schemas/commonUserInfo" }, "category": { "type": "string", "example": "ENUM_VALUE" }, "createdOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "data": { "$ref": "#/components/schemas/manaV2DeviceSnapshotData" }, "golden": { "type": "boolean", "example": true }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "name": { "type": "string", "example": "6-1-24-status-check", "description": "name for the snapshot" } }, "additionalProperties": false }, "commonUserInfo": { "type": "object", "properties": { "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "exp": { "type": "integer", "format": "int64", "example": 1234567891011 }, "originalEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "permissions": { "$ref": "#/components/schemas/commonPermissions" }, "timeZone": { "type": "string", "example": "example string" }, "userId": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2DeviceSnapshotData": { "type": "object", "properties": { "OSPFInstalledRouteCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "T2SessionCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "TWAMPSessionCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "bfdSessionCount": { "type": "integer", "format": "int32", "example": 123 }, "bgpNeighborIpList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "bgpSessionCount": { "type": "integer", "format": "int32", "example": 123 }, "deviceRole": { "type": "string", "example": "ENUM_VALUE" }, "failedServicesCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "graphnosVersion": { "type": "string", "example": "example string" }, "installedLabels": { "type": "integer", "format": "int32", "example": 123 }, "ipsecSessionCount": { "type": "integer", "format": "int32", "example": 123 }, "ongoingAlerts": { "type": "integer", "format": "int32", "example": 123 }, "ospfNeighborIpList": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ospfSessionCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1DeviceSnapshotDeviceIdGetResponse": { "type": "object", "properties": { "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" } } }, "additionalProperties": false }, "v1DeviceSnapshotPutRequest": { "type": "object", "properties": { "golden": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "snapshotId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DeviceSnapshotPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DeviceSnapshotPostRequest": { "type": "object", "properties": { "category": { "type": "string", "example": "ENUM_VALUE" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "golden": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DeviceSnapshotPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1EnterpriseSnapshotGetResponse": { "type": "object", "properties": { "deviceSnapshotRecords": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2deviceSnapshotRow" } }, "deviceSnapshotMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/manaV2DeviceSnapshotList" } } }, "additionalProperties": false }, "manaV2deviceSnapshotRow": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostname": { "type": "string", "example": "example string" }, "region": { "type": "string", "example": "example string" }, "site": { "type": "string", "example": "example string" }, "snapshotCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" } }, "uptime": { "$ref": "#/components/schemas/googleProtobufDuration" } }, "additionalProperties": false }, "manaV2DeviceSnapshotList": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123 }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DeviceSnapshot" } } }, "additionalProperties": false }, "v1GlobalDomainCategoriesGetResponse": { "type": "object", "properties": { "domainCategories": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2DomainCategory" } } }, "additionalProperties": false }, "manaV2DomainCategory": { "type": "object", "properties": { "description": { "type": "string", "example": "example string", "description": "Optional longer text describing what sites or traffic belong in this category." }, "id": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Stable identifier for this domain category in the content-filter catalog." }, "name": { "type": "string", "example": "example string", "description": "Human-readable name of the domain category." }, "type": { "type": "string", "example": "example string", "description": "Optional category classifier or grouping hint from the catalog (e.g. vendor-specific type)." } }, "additionalProperties": false }, "v1GlobalContentFiltersGetResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalContentFiltersGetResponseRow" } } }, "additionalProperties": false }, "v1GlobalContentFiltersGetResponseRow": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "globalContentFilterId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "ID for the global content filter." }, "globalContentFilterName": { "type": "string", "example": "example string", "description": "Given name of this global content filter." }, "lans": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalContentFiltersGetResponseRowLanEntry" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalContentFiltersGetResponseRowRuleEntry" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalContentFiltersGetResponseRowSiteEntry" } }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1GlobalContentFiltersGetResponseRowLanEntry": { "type": "object", "properties": { "lanName": { "type": "string", "example": "example string", "description": "Name of a LAN segment that the filter is applied on." } }, "additionalProperties": false }, "v1GlobalContentFiltersGetResponseRowRuleEntry": { "type": "object", "properties": { "domainCategory": { "type": "string", "example": "example string", "description": "Name of the domain category whose traffic is blocked by this rule." }, "exceptionWildcards": { "type": "array", "items": { "type": "string", "example": "example string", "description": "Wildcard patterns for domains that remain allowed despite the category block." } } }, "additionalProperties": false }, "v1GlobalContentFiltersGetResponseRowSiteEntry": { "type": "object", "properties": { "siteName": { "type": "string", "example": "example string", "description": "Display name of a site included in this filter's global or site-list-bounded scope." } }, "additionalProperties": false }, "v1GlobalContentFiltersPostRequest": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2GlobalContentFilterConfig" } }, "additionalProperties": false }, "manaV2GlobalContentFilterConfig": { "type": "object", "properties": { "lanNames": { "type": "array", "items": { "type": "string", "example": "example string", "description": "LAN interface names to scope the filter; when empty, all LANs are included." } }, "name": { "type": "string", "example": "example string", "description": "Display name for this global content filter configuration." }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalContentFilterRule" } }, "siteListId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Site list whose members this content filter applies to; omit the oneof when no site scope is set." }, "useAllSites": { "type": "boolean", "example": true, "description": "When true, the filter applies to all sites in the tenant (must be the constant true)." } }, "additionalProperties": false }, "manaV2GlobalContentFilterRule": { "type": "object", "properties": { "domainCategoryId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "ID of the category whose traffic will be blocked by the content filter." }, "exceptionWildcards": { "type": "array", "items": { "type": "string", "example": "example string", "description": "List of wildcard strings each representing a selection of domains that are exceptions that will not be blocked even if it is in the provided category" } } }, "additionalProperties": false }, "v1GlobalContentFiltersPostResponse": { "type": "object", "properties": { "globalContentFilterId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Server-assigned ID for the newly created global content filter." } }, "additionalProperties": false }, "v1GlobalContentFiltersGlobalContentFilterIdPutRequest": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2GlobalContentFilterConfig" } }, "additionalProperties": false }, "v1GlobalContentFiltersGlobalContentFilterIdPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalContentFiltersGlobalContentFilterIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalContentFiltersGlobalContentFilterIdGetResponse": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2GlobalContentFilterConfig" } }, "additionalProperties": false }, "v1GlobalAppsGraphiantGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalAppsGraphiantGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalAppsGraphiantGetResponseEntry": { "type": "object", "properties": { "app": { "$ref": "#/components/schemas/manaV2App" }, "appListReferenceCount": { "type": "integer", "format": "int32", "example": 123 }, "policyReferenceCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2App": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "identifier": { "$ref": "#/components/schemas/manaV2AppIdentifier" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2AppIdentifier": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1234567891011 }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1GlobalAppsCategoriesGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalAppsCategoriesGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalAppsCategoriesGetResponseEntry": { "type": "object", "properties": { "appCount": { "type": "integer", "format": "int32", "example": 123 }, "category": { "$ref": "#/components/schemas/manaV2App" } }, "additionalProperties": false }, "v1GlobalAppsCategoriesCategoryIdAppsGetResponse": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2App" } } }, "additionalProperties": false }, "v1GlobalAppsCustomGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalAppsCustomGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalAppsCustomGetResponseEntry": { "type": "object", "properties": { "app": { "$ref": "#/components/schemas/manaV2App" }, "appConfig": { "$ref": "#/components/schemas/manaV2GlobalAppConfig" }, "appListReferenceCount": { "type": "integer", "format": "int32", "example": 123 }, "policyReferenceCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "manaV2GlobalAppConfig": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "ipLists": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ipPrefixes": { "type": "array", "items": { "type": "string", "example": "example string" } }, "ipProtocol": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "portRanges": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2GlobalAppPortRange" } }, "url": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "manaV2GlobalAppPortRange": { "type": "object", "properties": { "lower": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "upper": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1GlobalAppsCustomPostRequest": { "type": "object", "properties": { "appConfig": { "$ref": "#/components/schemas/manaV2GlobalAppConfig" } }, "additionalProperties": false }, "v1GlobalAppsCustomPostResponse": { "type": "object", "properties": { "appIdentifier": { "$ref": "#/components/schemas/manaV2AppIdentifier" } }, "additionalProperties": false }, "v1GlobalAppsCustomAppIdPutRequest": { "type": "object", "properties": { "appConfig": { "$ref": "#/components/schemas/manaV2GlobalAppConfig" } }, "additionalProperties": false }, "v1GlobalAppsCustomAppIdPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalAppsCustomAppIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalAppsCustomAppIdGetResponse": { "type": "object", "properties": { "appConfig": { "$ref": "#/components/schemas/manaV2GlobalAppConfig" } }, "additionalProperties": false }, "v1GlobalAppsCustomAppIdDetailsAppListsGetResponse": { "type": "object", "properties": { "appLists": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2App" } } }, "additionalProperties": false }, "v1GlobalAppsAppListOptionsGetResponse": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2App" } } }, "additionalProperties": false }, "v1GlobalAppsAppListsGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1GlobalAppsAppListsGetResponseEntry" } } }, "additionalProperties": false }, "v1GlobalAppsAppListsGetResponseEntry": { "type": "object", "properties": { "appCount": { "type": "integer", "format": "int32", "example": 123 }, "appList": { "$ref": "#/components/schemas/manaV2App" }, "policyReferenceCount": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1GlobalAppsAppListsPostRequest": { "type": "object", "properties": { "appListConfig": { "$ref": "#/components/schemas/manaV2AppListConfig" } }, "additionalProperties": false }, "manaV2AppListConfig": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2AppIdentifier" } }, "description": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1GlobalAppsAppListsPostResponse": { "type": "object", "properties": { "appIdentifier": { "$ref": "#/components/schemas/manaV2AppIdentifier" } }, "additionalProperties": false }, "v1GlobalAppsAppListsAppListIdPutRequest": { "type": "object", "properties": { "appListConfig": { "$ref": "#/components/schemas/manaV2AppListConfig" } }, "additionalProperties": false }, "v1GlobalAppsAppListsAppListIdPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalAppsAppListsAppListIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1GlobalAppsAppListsAppListIdGetResponse": { "type": "object", "properties": { "appListConfig": { "$ref": "#/components/schemas/manaV2AppListConfig" } }, "additionalProperties": false }, "v1GlobalAppsAppListsAppListIdDetailsAppsGetResponse": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2App" } } }, "additionalProperties": false }, "v1DataAssuranceFlexAlgosGetResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceFlexAlgosGetResponseEntry" } } }, "additionalProperties": false }, "v1DataAssuranceFlexAlgosGetResponseEntry": { "type": "object", "properties": { "description": { "type": "string", "example": "example string" }, "id": { "type": "integer", "format": "int32", "example": 123 }, "name": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalGetResponse": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalGetResponseRow" } } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalGetResponseRow": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalGetResponseRowAppEntry" } }, "assuranceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "assuranceName": { "type": "string", "example": "example string" }, "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "flexAlgo": { "type": "string", "example": "example string" }, "lans": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalGetResponseRowLanEntry" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalGetResponseRowSiteEntry" } }, "updatedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalGetResponseRowAppEntry": { "type": "object", "properties": { "appName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalGetResponseRowLanEntry": { "type": "object", "properties": { "lanName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalGetResponseRowSiteEntry": { "type": "object", "properties": { "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalPostRequest": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2AssuranceConfig" } }, "additionalProperties": false }, "manaV2AssuranceConfig": { "type": "object", "properties": { "apps": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BucketApp" } }, "flexAlgo": { "type": "string", "example": "example string" }, "lanNames": { "type": "array", "items": { "type": "string", "example": "example string" } }, "name": { "type": "string", "example": "example string" }, "siteListId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "useAllSites": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BucketApp": { "type": "object", "properties": { "bucketId": { "type": "integer", "format": "int32", "example": 123 }, "builtinAppId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "customAppId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "isDomain": { "type": "boolean", "example": true }, "name": { "type": "string", "example": "example string" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/manaV2BucketAppServer" } }, "useAllServers": { "type": "boolean", "example": true } }, "additionalProperties": false }, "manaV2BucketAppServer": { "type": "object", "properties": { "ip": { "type": "string", "example": "example string" }, "port": { "type": "integer", "format": "int32", "example": 123 }, "protocol": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalPostResponse": { "type": "object", "properties": { "assuranceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "unsyncedDeviceNames": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalIdPutRequest": { "type": "object", "properties": { "appRemovalReason": { "type": "string", "example": "example string" }, "config": { "$ref": "#/components/schemas/manaV2AssuranceConfig" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalIdPutResponse": { "type": "object", "properties": { "unsyncedDeviceNames": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DataAssuranceAssurancesGlobalIdGetResponse": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/manaV2AssuranceConfig" } }, "additionalProperties": false }, "v1DataAssuranceAssurancesApplicationsBucketAppNameGetResponse": { "type": "object", "properties": { "assurances": { "type": "array", "items": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesApplicationsBucketAppNameGetResponseAssurance" } } }, "additionalProperties": false }, "v1DataAssuranceAssurancesApplicationsBucketAppNameGetResponseAssurance": { "type": "object", "properties": { "configs": { "$ref": "#/components/schemas/manaV2AssuranceConfig" }, "id": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DevicesDeviceIdControllerPeersPutRequest": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "controllerDeviceId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DevicesDeviceIdControllerPeersPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesOauthPostRequest": { "type": "object", "properties": { "grant_type": { "type": "string", "enum": [ "client_credentials" ], "example": "client_credentials", "description": "OAuth grant type" }, "scope": { "type": "string", "example": "type=zt-cpe uuid=device-uuid-123 hostname=device.example.com", "description": "OAuth scope containing device type, UUID, and hostname" }, "state": { "type": "string", "example": "state-12345", "description": "OAuth state parameter" }, "code_verify": { "type": "string", "example": "code-verify-12345", "description": "OAuth code verifier" }, "pt": { "type": "string", "example": "hardware", "description": "Platform type" }, "bm": { "type": "string", "example": "p", "description": "Boot mode" } }, "required": [ "grant_type", "scope" ] }, "v1DevicesOauthPostResponse": { "type": "object", "properties": { "access_token": { "type": "string", "example": "access-token-12345", "description": "OAuth access token" }, "expires_in": { "type": "integer", "example": 3600, "description": "Token expiration time in seconds" }, "token_type": { "type": "string", "example": "Bearer", "description": "Token type" } } }, "v1DevicesOauthAuthorizationGetResponse": { "type": "object", "properties": { "auth_code": { "type": "string", "example": "auth-code-12345", "description": "OAuth authorization code" } } }, "v1DevicesBringupPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } }, "additionalProperties": false }, "v1DevicesBringupPostResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingOnboardingSummary" } } }, "additionalProperties": false }, "onboardingOnboardingSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "discoveredLocation": { "type": "string", "example": "example string" }, "firstAppearedOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ipDetected": { "type": "string", "example": "example string" }, "isNew": { "type": "boolean", "example": true }, "state": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DevicesBringupPutRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DevicesClearNewFlagPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesClearNewFlagPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesInventoryPostRequest": { "type": "object", "properties": { "hardwareInventoryList": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingHardwareInventory" } } }, "additionalProperties": false }, "onboardingHardwareInventory": { "type": "object", "properties": { "assignedOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "createdOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "deviceModel": { "type": "string", "example": "example string" }, "deviceSerial": { "type": "string", "example": "example string" }, "ekCert": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enterpriseName": { "type": "string", "example": "example string" }, "gekPub": { "type": "string", "example": "example string" }, "isCore": { "type": "boolean", "example": true }, "isNew": { "type": "boolean", "example": true }, "isRequested": { "type": "boolean", "example": true }, "parentEnterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "parentEnterpriseName": { "type": "string", "example": "example string" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "useOauth": { "type": "boolean", "example": true }, "uuid": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesInventoryPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesInventoryPostResponseData" } } }, "additionalProperties": false }, "v1DevicesInventoryPostResponseData": { "type": "object", "properties": { "deviceSerial": { "type": "string", "example": "example string" }, "uuid": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesInventoryEnterprisePutRequest": { "type": "object", "properties": { "deviceSerials": { "type": "array", "items": { "type": "string", "example": "example string" } }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DevicesInventoryGetResponse": { "type": "object", "properties": { "inventory": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingHardwareInventory" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" } }, "additionalProperties": false }, "v1DevicesInventoryClearNewFlagPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesInventoryClearNewFlagPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesInventoryRequestReturnPostRequest": { "type": "object", "properties": { "deviceSerials": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DevicesInventoryRequestReturnPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesInventoryClearReturnPostRequest": { "type": "object", "properties": { "deviceSerials": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DevicesInventoryClearReturnPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesInventoryApproveReturnPostRequest": { "type": "object", "properties": { "deviceSerials": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1DevicesInventoryApproveReturnPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesRmaPostRequest": { "type": "object", "properties": { "currentDeviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "newDeviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "v1DevicesRmaPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DevicesBringupTokenPostRequest": { "type": "object", "properties": { "role": { "type": "string", "example": "ENUM_VALUE" }, "validTillTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "validitySec": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "additionalProperties": false }, "v1DevicesBringupTokenPostResponse": { "type": "object", "properties": { "accessToken": { "type": "string", "example": "example string" }, "validTillTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1OnboardingCloudinitPostRequest": { "type": "object", "properties": { "cloudinitTokens": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingCloudInitToken" } } }, "additionalProperties": false }, "onboardingCloudInitToken": { "type": "object", "properties": { "cloudinitConfig": { "$ref": "#/components/schemas/onboardingCloudInitConfiguration" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceSerial": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "token": { "$ref": "#/components/schemas/onboardingCloudInitTokenToken" } }, "additionalProperties": false }, "onboardingCloudInitConfiguration": { "type": "object", "properties": { "deviceType": { "type": "string", "example": "example string" }, "dnsServers": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" }, "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingInterface" } }, "localWebPassword": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "onboardingInterface": { "type": "object", "properties": { "ipv4": { "$ref": "#/components/schemas/onboardingIp" }, "ipv6": { "$ref": "#/components/schemas/onboardingIp" }, "name": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "onboardingIp": { "type": "object", "properties": { "gatewayAddr": { "type": "string", "example": "example string" }, "ipAddr": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "onboardingCloudInitTokenToken": { "type": "object", "properties": { "createdByTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "expiryByTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "token": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1OnboardingCloudinitPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1OnboardingCloudinitGetResponse": { "type": "object", "properties": { "cloudinitTokens": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingCloudInitToken" } } }, "additionalProperties": false }, "v1DeviceStatusPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "role": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DeviceStatusPostResponse": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/pokedexDeviceMappingInfo" } } }, "additionalProperties": false }, "pokedexDeviceMappingInfo": { "type": "object", "properties": { "connectTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "enterpriseId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "hostname": { "type": "string", "example": "example string" }, "ipaddress": { "type": "string", "example": "example string" }, "ttIdentity": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DeviceStatusHistoryPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "role": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1DeviceStatusHistoryPostResponse": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/pokedexDeviceHistoryInfo" } } }, "additionalProperties": false }, "pokedexDeviceHistoryInfo": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "enterpriseId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "event": { "type": "string", "example": "ENUM_VALUE" }, "eventTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "ipaddress": { "type": "string", "example": "example string" }, "ttIdentity": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1EnterprisesEnterpriseIdDeviceStatusGetResponse": { "type": "object", "properties": { "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/pokedexDeviceMappingInfo" } } }, "additionalProperties": false }, "routingPrefixFilter": { "type": "object", "properties": { "asPath": { "type": "array", "items": { "type": "string", "example": "[1234, 43650, 12456]", "description": "List of as paths" } }, "extCommunity": { "type": "string", "example": "example string" }, "interfaceName": { "type": "string", "example": "ethernet1/0", "description": "Interface name" }, "nextHop": { "type": "string", "example": "10.1.1.1", "description": "IPv4 or IPv6 Nexthop" }, "prefix": { "type": "string", "example": "example string" }, "rd": { "type": "string", "example": "10:1231", "description": "Route RD. Must for BGPAddrFamilyVpnIpv4Unicast/BGPAddrFamilyVpnIpv6Unicast" }, "srcProto": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "internal or external", "description": "route type" } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2RibGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "routes": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfRoute" } }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "routingOspfRoute": { "type": "object", "properties": { "ipPrefix": { "type": "string", "example": "131.1.0.0/16", "description": "IPv4 or IPv6 Prefix (required)" }, "path": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfNextHop" } } }, "additionalProperties": false }, "routingOspfNextHop": { "type": "object", "properties": { "egressInterface": { "type": "string", "example": "ATTInterface", "description": "Interface name (required)" }, "lastModified": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "metric": { "type": "integer", "format": "int32", "example": 120, "minimum": 0, "description": "value > 0 (required)" }, "nextHop": { "type": "string", "example": "10.1.1.1", "description": "IPv4 or IPv6 Nexthop (required)" }, "tag": { "type": "integer", "format": "int32", "example": 12312, "minimum": 0, "description": "admin assigned number (required)" }, "type": { "type": "string", "example": "internal or external", "description": "route type (required)" } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3RibGetResponse": { "type": "object", "properties": { "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "routes": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfRoute" } }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2StatisticsGetResponse": { "type": "object", "properties": { "statistics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/routingOspfStatistics" } } }, "additionalProperties": false }, "routingOspfStatistics": { "type": "object", "properties": { "discontinuityTime": { "type": "string", "example": "example string" }, "routeCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3StatisticsGetResponse": { "type": "object", "properties": { "statistics": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/routingOspfStatistics" } } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2LsdbGetResponse": { "type": "object", "properties": { "lsas": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspflsa" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "routingOspflsa": { "type": "object", "properties": { "advertisingRouter": { "type": "string", "example": "172.121.12.34", "description": "IP address (required)" }, "age": { "type": "integer", "format": "int32", "example": 3242342, "minimum": 0, "description": "How old is the LSA (required)" }, "asexternalLsa": { "$ref": "#/components/schemas/routingOspfasExternalLsa" }, "checksum": { "type": "integer", "format": "int32", "example": 2343232, "minimum": 0, "description": "LSA Checksum (required)" }, "length": { "type": "integer", "format": "int32", "example": 123132, "minimum": 0, "description": "LSA length (required)" }, "linkId": { "type": "string", "example": "143.12.1.5", "description": "IP address of link on peer (required)" }, "networkLsa": { "$ref": "#/components/schemas/routingOspfNetworkLsa" }, "routerLsa": { "$ref": "#/components/schemas/routingOspfRouterLsa" }, "sequenceNumber": { "type": "string", "example": "0x80000001", "description": "LSA sequence number (required)" }, "summaryLsa": { "$ref": "#/components/schemas/routingOspfSummaryLsa" }, "type": { "type": "string", "example": "Router", "description": "Type of LSA (required)" } }, "additionalProperties": false }, "routingOspfasExternalLsa": { "type": "object", "properties": { "forwardingAddress": { "type": "string", "example": "example string" }, "metric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "metricType": { "type": "string", "example": "example string" }, "networkMask": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tag": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tosMetric": { "$ref": "#/components/schemas/routingOspflsaTosMetric" } }, "additionalProperties": false }, "routingOspflsaTosMetric": { "type": "object", "properties": { "tos": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tosMetric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "routingOspfNetworkLsa": { "type": "object", "properties": { "attachedRouters": { "type": "array", "items": { "type": "string", "example": "example string" } }, "networkMask": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "routingOspfRouterLsa": { "type": "object", "properties": { "links": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfRouterLsaLink" } } }, "additionalProperties": false }, "routingOspfRouterLsaLink": { "type": "object", "properties": { "linkData": { "type": "string", "example": "example string" }, "linkId": { "type": "string", "example": "example string" }, "linkType": { "type": "string", "example": "example string" }, "metric": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tosMetric": { "$ref": "#/components/schemas/routingOspflsaTosMetric" } }, "additionalProperties": false }, "routingOspfSummaryLsa": { "type": "object", "properties": { "networkMask": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "tosMetric": { "$ref": "#/components/schemas/routingOspflsaTosMetric" } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2AreaidGetResponse": { "type": "object", "properties": { "areas": { "type": "array", "items": { "type": "string", "example": "10.121.12.34, 1.1.1.1", "description": "Area IDs (required)" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2AreaLsdbGetResponse": { "type": "object", "properties": { "lsas": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspflsa" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2AreaInterfaceGetResponse": { "type": "object", "properties": { "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfInterface" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "routingOspfInterface": { "type": "object", "properties": { "bdrIpAddr": { "type": "string", "example": "131.34.23.11", "description": "Router IP Address (required)" }, "bdrRouterId": { "type": "string", "example": "1.1.1.1", "description": "BDR Router ID (required)" }, "drIpAddr": { "type": "string", "example": "131.34.23.11", "description": "Router IP Address (required)" }, "drRouterId": { "type": "string", "example": "1.1.1.1", "description": "Router ID (required)" }, "helloInterval": { "type": "string", "example": "example string" }, "helloTimer": { "type": "string", "example": 50, "description": "Timer in seconds (required)" }, "name": { "type": "string", "example": "ethernet1/0", "description": "Interface name (required)" }, "neighbors": { "type": "array", "items": { "type": "string", "example": "1.1.12.12", "description": "Nbr Router ID (required)" } }, "state": { "type": "string", "example": "Loopback", "description": "interface state (required)" }, "waitTimer": { "type": "string", "example": 50, "description": "Timer in seconds (required)" } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2AreaInterfaceNbridGetResponse": { "type": "object", "properties": { "nbrs": { "type": "array", "items": { "type": "string", "example": "2.2.2.2", "description": "Neighbor Address (required)" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv2AreaNbrGetResponse": { "type": "object", "properties": { "nbrs": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfNbr" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "routingOspfNbr": { "type": "object", "properties": { "address": { "type": "string", "example": "1.1.1.1", "description": "v4 or v6 Address (required)" }, "cost": { "type": "integer", "format": "int32", "example": 230, "minimum": 0, "description": "cost (required)" }, "deadTimer": { "type": "integer", "format": "int32", "example": 40, "minimum": 0, "description": "Dead Timer (required)" }, "lastStateChange": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "routerId": { "type": "string", "example": "1.1.1.1", "description": "Router ID (required)" }, "state": { "type": "string", "example": "up or down", "description": "interface state (required)" } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3LsdbGetResponse": { "type": "object", "properties": { "lsas": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspflsa" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3AreaidGetResponse": { "type": "object", "properties": { "areas": { "type": "array", "items": { "type": "string", "example": "10.121.12.34, 1.1.1.1", "description": "Area IDs (required)" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3AreaLsdbGetResponse": { "type": "object", "properties": { "lsas": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspflsa" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3AreaInterfaceGetResponse": { "type": "object", "properties": { "interfaces": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfInterface" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOspfv3AreaNbrGetResponse": { "type": "object", "properties": { "nbrs": { "type": "array", "items": { "$ref": "#/components/schemas/routingOspfNbr" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingBgpNbridGetResponse": { "type": "object", "properties": { "nbrs": { "type": "array", "items": { "type": "string", "example": "10.121.12.34, 1211:343:ac34::12", "description": "BGP Nbr addresses (required)" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingOdpNbridGetResponse": { "type": "object", "properties": { "nbrs": { "type": "array", "items": { "type": "string", "example": "10.121.12.34, 1211:343:ac34::12", "description": "BGP Nbr addresses (required)" } }, "pageInfo": { "$ref": "#/components/schemas/commonPageInfo" }, "token": { "type": "string", "example": "xxxxxxxxx", "description": "Reference to the resultset being queried, this should be sent by the service as part of a previous request and so can be opaque to the client." } }, "additionalProperties": false }, "v1DeviceRoutingBgpNbrsDetailsGetResponse": { "type": "object", "properties": { "ebgpMultiHopTtl": { "type": "integer", "format": "int32", "example": 123 }, "holdTimer": { "type": "integer", "format": "int32", "example": 123 }, "keepAliveTimer": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1DeviceRoutingRibRouteCountPostRequest": { "type": "object", "properties": {}, "additionalProperties": false }, "v1DeviceRoutingRibRouteCountPostResponse": { "type": "object", "properties": { "counts": { "type": "array", "items": { "$ref": "#/components/schemas/v1DeviceRoutingRibRouteCountPostResponseRouteCount" } } }, "additionalProperties": false }, "v1DeviceRoutingRibRouteCountPostResponseRouteCount": { "type": "object", "properties": { "routeCount": { "type": "integer", "format": "int64", "example": 1234, "description": "Total installed route count in a vrf (required)" }, "vrfName": { "type": "string", "example": "management", "description": "Valid configured VRF name (required)" } }, "additionalProperties": false }, "v1DevicesRoutingVrfProtocolRouteCountGetResponse": { "type": "object", "properties": { "counts": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesRoutingVrfProtocolRouteCountGetResponseProtocolCount" } } }, "additionalProperties": false }, "v1DevicesRoutingVrfProtocolRouteCountGetResponseProtocolCount": { "type": "object", "properties": { "protocol": { "type": "string", "example": "OSPF", "description": "Configured protocol (required)" }, "routeCount": { "$ref": "#/components/schemas/routingAfiRouteCount" } }, "additionalProperties": false }, "routingAfiRouteCount": { "type": "object", "properties": { "ipv4": { "type": "integer", "format": "int64", "example": 32, "description": "IPv4 route count" }, "ipv6": { "type": "integer", "format": "int64", "example": 6532, "description": "IPv6 route count" } }, "additionalProperties": false }, "v1DeviceRoutingVrfBgpRouteCountPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1000000, "description": "Valid configured device ID > 0 (required)" }, "vrfName": { "type": "array", "items": { "type": "string", "example": "management", "description": "Valid configured VRF names (required)" } } }, "additionalProperties": false, "required": [ "deviceId", "vrfName" ] }, "v1DeviceRoutingVrfBgpRouteCountPostResponse": { "type": "object", "properties": { "counts": { "type": "array", "items": { "$ref": "#/components/schemas/v1DeviceRoutingVrfBgpRouteCountPostResponseRouteCount" } } }, "additionalProperties": false }, "v1DeviceRoutingVrfBgpRouteCountPostResponseRouteCount": { "type": "object", "properties": { "routeCount": { "type": "integer", "format": "int64", "example": 1234, "description": "total route count in a vrf (required)" }, "vrfName": { "type": "string", "example": "management", "description": "Valid configured VRF name (required)" } }, "additionalProperties": false }, "v1DeviceRoutingVrfBgpEibgpRouteCountGetResponse": { "type": "object", "properties": { "ebgpRouteCount": { "$ref": "#/components/schemas/routingAfiRouteCount" }, "graphiantRouteCount": { "$ref": "#/components/schemas/routingAfiRouteCount" }, "ibgpRouteCount": { "$ref": "#/components/schemas/routingAfiRouteCount" }, "localSourcedRouteCount": { "$ref": "#/components/schemas/routingAfiRouteCount" }, "totalRouteCount": { "$ref": "#/components/schemas/routingAfiRouteCount" } }, "additionalProperties": false }, "v1DevicesDeviceIdArpGetResponse": { "type": "object", "properties": { "arpEntry": { "type": "array", "items": { "$ref": "#/components/schemas/routingArpEntry" } } }, "additionalProperties": false }, "routingArpEntry": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "ipv4Address": { "type": "string", "example": "example string" }, "macAddress": { "type": "string", "example": "example string" }, "name": { "type": "string", "example": "example string", "description": "Circuit or VRF name" } }, "additionalProperties": false }, "v1DevicesDeviceIdVrrpGetResponse": { "type": "object", "properties": { "vrrpEntry": { "type": "array", "items": { "$ref": "#/components/schemas/routingVrrpEntry" } } }, "additionalProperties": false }, "routingVrrpEntry": { "type": "object", "properties": { "addressFamily": { "type": "string", "example": "IPv4 or IPv6", "description": "type of IP address" }, "advertisementRcvd": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "advertisementSent": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "effectivePriority": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "groupId": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "isOwner": { "type": "boolean", "example": true }, "masterTransition": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "newMasterReason": { "type": "string", "example": "UNSET = 0" }, "priorityZeroPktsRcvd": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "priorityZeroPktsSent": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "state": { "type": "string", "example": "UNSET = 0" } }, "additionalProperties": false }, "v1DeviceRoutingBgpNbrsPerAfiPrefixGetResponse": { "type": "object", "properties": { "prefixes": { "type": "array", "items": { "$ref": "#/components/schemas/routingprefix" } } }, "additionalProperties": false }, "routingprefix": { "type": "object", "properties": { "afiSafiName": { "type": "string", "example": "example string" }, "prefixRcvd": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "prefixSent": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1DeviceRoutingBgpNbrsCountersGetResponse": { "type": "object", "properties": { "counters": { "type": "array", "items": { "$ref": "#/components/schemas/routingbgpCounter" } } }, "additionalProperties": false }, "routingbgpCounter": { "type": "object", "properties": { "gracefulRestart": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "localAsNumber": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "localIpAddress": { "type": "string", "example": "example string" }, "localRouterId": { "type": "string", "example": "example string" }, "peerRouterId": { "type": "string", "example": "example string" }, "upTime": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "searchSearchFilter": { "type": "object", "properties": { "role": { "type": "string", "example": "ENUM_VALUE" }, "siteName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "active", "description": "Status of the device, valid values are staging, active, inactive (required)" } }, "additionalProperties": false, "required": [ "status" ] }, "v1SearchGetResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/searchSearchResult" } } }, "additionalProperties": false }, "searchSearchResult": { "type": "object", "properties": { "context": { "type": "string", "example": 1, "description": "A search context from the SearchContext enum (required)" }, "id": { "type": "integer", "format": "int64", "example": 1234, "minimum": 0, "description": "A search context from the SearchContext enum (required)" }, "result": { "type": "string", "example": "example string", "description": "A search result (required)" } }, "additionalProperties": false }, "v1EdgesSummaryGetResponse": { "type": "object", "properties": { "edgesSummary": { "type": "array", "items": { "$ref": "#/components/schemas/searchEdgeSummary" } }, "isNewCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "searchEdgeSummary": { "type": "object", "properties": { "assignedOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "canaryMode": { "type": "string", "example": "ENUM_VALUE" }, "connectedRegions": { "type": "array", "items": { "type": "string", "example": "example string" } }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "discoveredLocation": { "type": "string", "example": "example string" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enterpriseName": { "type": "string", "example": "example string" }, "firstAppearedOn": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "hostname": { "type": "string", "example": "example string" }, "ipDetected": { "type": "string", "example": "example string" }, "isHardware": { "type": "boolean", "example": true }, "isNew": { "type": "boolean", "example": true }, "isRequested": { "type": "boolean", "example": true }, "isRequestedStatus": { "type": "string", "example": "ENUM_VALUE" }, "lastBootedAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "location": { "$ref": "#/components/schemas/manaV2Location" }, "model": { "type": "string", "example": "example string" }, "overrideRegion": { "type": "string", "example": "example string" }, "parentEnterpriseName": { "type": "string", "example": "example string" }, "portalStatus": { "type": "string", "example": "ENUM_VALUE" }, "region": { "type": "string", "example": "example string" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "serialNum": { "type": "string", "example": "example string" }, "site": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "stale": { "type": "boolean", "example": true }, "status": { "type": "string", "example": "ENUM_VALUE" }, "swName": { "type": "string", "example": "example string" }, "swVersion": { "type": "string", "example": "example string" }, "ttConnCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "upgradeSummary": { "$ref": "#/components/schemas/upgradeUpgradeSummary" } }, "additionalProperties": false }, "upgradeUpgradeSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "endOfLife": { "type": "boolean", "example": true }, "lastDiscoveredTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lastRunningVersion": { "$ref": "#/components/schemas/upgradeSwVersion" }, "lastUpgradeTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "readyForActivationVersion": { "$ref": "#/components/schemas/upgradeSwVersion" }, "rolloutId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "rolloutName": { "type": "string", "example": "example string" }, "runningVersion": { "$ref": "#/components/schemas/upgradeSwVersion" }, "schedule": { "$ref": "#/components/schemas/upgradeSchedule" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "upgradeSwVersion": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "release": { "type": "string", "example": "ENUM_VALUE" }, "version": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "upgradeSchedule": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "downloadProgress": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "failureReason": { "type": "string", "example": "example string" }, "state": { "type": "string", "example": "ENUM_VALUE" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "version": { "$ref": "#/components/schemas/upgradeSwVersion" } }, "additionalProperties": false }, "v1EdgesSummaryPostRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/v1EdgesSummaryPostRequestFilter" } }, "additionalProperties": false }, "v1EdgesSummaryPostRequestFilter": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "roles": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } }, "statuses": { "type": "array", "items": { "type": "string", "example": "ENUM_VALUE" } } }, "additionalProperties": false }, "v1EdgesSummaryPostResponse": { "type": "object", "properties": { "edgesSummary": { "type": "array", "items": { "$ref": "#/components/schemas/searchEdgeSummary" } } }, "additionalProperties": false }, "v1EdgesHardwareUnassignedGetResponse": { "type": "object", "properties": { "inventory": { "type": "array", "items": { "$ref": "#/components/schemas/onboardingHardwareInventory" } }, "isNewCount": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, "additionalProperties": false }, "v1EdgesHardwareAssignedGetResponse": { "type": "object", "properties": { "edgesSummary": { "type": "array", "items": { "$ref": "#/components/schemas/searchEdgeSummary" } } }, "additionalProperties": false }, "v2MonitoringInterfacePostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2InterfaceStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2InterfaceStatsSelector": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonV2TimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2MonitoringInterfacePostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringInterfacePostResponseData" } } }, "additionalProperties": false }, "v2MonitoringInterfacePostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2InterfaceStatsSelector" } }, "additionalProperties": false }, "statsmonV2StatsSample": { "type": "object", "properties": { "status": { "type": "string", "example": "ENUM_VALUE" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "value": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v2MonitoringSystemPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2SystemStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2SystemStatsSelector": { "type": "object", "properties": { "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringSystemPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringSystemPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringSystemPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2SystemStatsSelector" } }, "additionalProperties": false }, "v2MonitoringIpsecPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2IpSecStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2IpSecStatsSelector": { "type": "object", "properties": { "peerGdi": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringIpsecPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringIpsecPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringIpsecPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2IpSecStatsSelector" } }, "additionalProperties": false }, "v2MonitoringIkeErrorHistoryPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" }, "tunnelName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2MonitoringIkeErrorHistoryPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringIkeErrorHistoryPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringIkeErrorHistoryPostResponseData": { "type": "object", "properties": { "destinationAddress": { "type": "string", "example": "example string" }, "destinationPort": { "type": "string", "example": "example string" }, "errorType": { "type": "string", "example": "ENUM_VALUE" }, "message": { "type": "string", "example": "example string" }, "timestamp": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "tunnelName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2MonitoringPolicyPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2PolicyStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2PolicyStatsSelector": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringPolicyPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringPolicyPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringPolicyPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2PolicyStatsSelector" } }, "additionalProperties": false }, "v2MonitoringQueueInstantPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "isDelta": { "type": "boolean", "example": true }, "isTotal": { "type": "boolean", "example": true }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2QueueInstantStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2QueueInstantStatsSelector": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "slaClass": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringQueueInstantPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringQueueInstantPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringQueueInstantPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2QueueInstantStatsSelector" } }, "additionalProperties": false }, "v2MonitoringCircuitsBandwidthPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitBandwidthStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2CircuitBandwidthStatsSelector": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "v2MonitoringCircuitsBandwidthPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringCircuitsBandwidthPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringCircuitsBandwidthPostResponseData": { "type": "object", "properties": { "carrier": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "dlBwKbpsSamples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2CircuitBandwidthStatsSelector" }, "ulBwKbpsSamples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } } }, "additionalProperties": false }, "v2MonitoringSiteCircuitsBandwidthSiteIdPostRequest": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitBandwidthStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2MonitoringSiteCircuitsBandwidthSiteIdPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringSiteCircuitsBandwidthSiteIdPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringSiteCircuitsBandwidthSiteIdPostResponseData": { "type": "object", "properties": { "dlBwKbpsSamples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2CircuitBandwidthStatsSelector" }, "ulBwKbpsSamples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } } }, "additionalProperties": false }, "v2MonitoringBgpPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2BgpStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2BgpStatsSelector": { "type": "object", "properties": { "peerAddress": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" }, "vrf": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2MonitoringBgpPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringBgpPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringBgpPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2BgpStatsSelector" } }, "additionalProperties": false }, "v2MonitoringBfdPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2BfdStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2BfdStatsSelector": { "type": "object", "properties": { "ifIndex": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "peerAddress": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringBfdPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringBfdPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringBfdPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2BfdStatsSelector" } }, "additionalProperties": false }, "v2MonitoringTwampPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2TwampStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2TwampStatsSelector": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "interfaceName": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringTwampPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringTwampPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringTwampPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2TwampStatsSelector" } }, "additionalProperties": false }, "v2MonitoringSiteTwampSiteIdPostRequest": { "type": "object", "properties": { "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2TwampStatsSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2MonitoringSiteTwampSiteIdPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringSiteTwampSiteIdPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringSiteTwampSiteIdPostResponseData": { "type": "object", "properties": { "carrier": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2TwampStatsSelector" } }, "additionalProperties": false }, "v2MonitoringCircuitsSummaryPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2MonitoringCircuitsSummaryPostResponse": { "type": "object", "properties": { "circuitSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitSummary" } } }, "additionalProperties": false }, "statsmonV2CircuitSummary": { "type": "object", "properties": { "averageDelay": { "type": "number", "format": "float", "example": 12.34, "description": "Average delay for this circuit in this time duration" }, "averageJitter": { "type": "number", "format": "float", "example": 12.34, "description": "Average jitter for this circuit in this time duration" }, "averageLinkDownSpeedKbps": { "type": "number", "format": "float", "example": 12.34 }, "averageLinkUpSpeedKbps": { "type": "number", "format": "float", "example": 12.34 }, "averageLoss": { "type": "number", "format": "float", "example": 12.34, "description": "Average loss for this circuit in this time duration" }, "avgMos": { "type": "number", "format": "float", "example": 12.34, "description": "Graphiant avg score/QoE based on mos for the time duration" }, "circuitName": { "type": "string", "example": "example string" }, "configLinkDownSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "configLinkUpSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "connectionStatus": { "type": "string", "example": "ENUM_VALUE" }, "currentLinkDownSpeedKbps": { "type": "number", "format": "float", "example": 12.34 }, "currentLinkUpSpeedKbps": { "type": "number", "format": "float", "example": 12.34 }, "delay": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0, "description": "Delay in nano seconds" }, "jitter": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0, "description": "Jitter in nano seconds" }, "lastResort": { "type": "boolean", "example": true }, "loss": { "type": "number", "format": "float", "example": 12.34, "description": "Loss in percentage" }, "maxDelay": { "type": "number", "format": "float", "example": 12.34, "description": "Max delay for this circuit in this time duration" }, "maxJitter": { "type": "number", "format": "float", "example": 12.34, "description": "Max jitter for this circuit in this time duration" }, "maxLoss": { "type": "number", "format": "float", "example": 12.34, "description": "Max loss for this circuit in this time duration" }, "maxMos": { "type": "number", "format": "float", "example": 12.34, "description": "Graphiant max score/QoE based on mos for the time duration" }, "minDelay": { "type": "number", "format": "float", "example": 12.34, "description": "Min delay for this circuit in this time duration" }, "minJitter": { "type": "number", "format": "float", "example": 12.34, "description": "Min jitter for this circuit in this time duration" }, "minLoss": { "type": "number", "format": "float", "example": 12.34, "description": "Min loss for this circuit in this time duration" }, "minMos": { "type": "number", "format": "float", "example": 12.34, "description": "Graphiant min score/QoE based on mos for the time duration" }, "mos": { "type": "number", "format": "float", "example": 12.34, "description": "Graphiant score/QoE based on mos" } }, "additionalProperties": false }, "v2MonitoringCircuitsUtilizationPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2CircuitUtilizationSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2CircuitUtilizationSelector": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2MonitoringCircuitsUtilizationPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringCircuitsUtilizationPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringCircuitsUtilizationPostResponseData": { "type": "object", "properties": { "configLinkUpSpeedMbps": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "queueUtilization": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2QueueUtilization" } }, "selector": { "$ref": "#/components/schemas/statsmonV2CircuitUtilizationSelector" } }, "additionalProperties": false }, "statsmonV2QueueUtilization": { "type": "object", "properties": { "allocatedPct": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "defaultQueue": { "type": "boolean", "example": true }, "excessWeight": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "slaClass": { "type": "string", "example": "ENUM_VALUE" }, "utilizationKbps": { "type": "number", "format": "float", "example": 12.34 }, "utilizationPct": { "type": "number", "format": "float", "example": 12.34 } }, "additionalProperties": false }, "v2MonitoringCircuitsVisualizationPostRequest": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2TwampVisualSelector" } }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "statsmonV2TwampVisualSelector": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" }, "coreLocation": { "type": "string", "example": "example string" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2MonitoringCircuitsVisualizationPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringCircuitsVisualizationPostResponseData" } }, "hostname": { "type": "string", "example": "example string", "description": "hostname of the device." } }, "additionalProperties": false }, "v2MonitoringCircuitsVisualizationPostResponseData": { "type": "object", "properties": { "samples": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2StatsSample" } }, "selector": { "$ref": "#/components/schemas/statsmonV2TwampVisualSelector" } }, "additionalProperties": false }, "v1BwtrackerEnterpriseSummaryPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "statsmonBandwidthtrackerTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1BwtrackerEnterpriseSummaryPostResponse": { "type": "object", "properties": { "bwusageSummary": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByEnterpriseSummary" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByEnterpriseSummary": { "type": "object", "properties": { "bwusageRoleSummary": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRoleSummary" } }, "bwusageTopRegions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByTopRegions" } }, "minTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "percentChanged": { "type": "number", "format": "double", "example": 123.45 }, "providerCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "regionCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByRoleSummary": { "type": "object", "properties": { "roleId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "roleName": { "type": "string", "example": "example string" }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByTopRegions": { "type": "object", "properties": { "bwusageRoleSummary": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRoleSummary" } }, "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "regionName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1BwtrackerEnterpriseDetailsPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerEnterpriseDetailsPostResponse": { "type": "object", "properties": { "bwusageDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByEnterpriseDetails" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByEnterpriseDetails": { "type": "object", "properties": { "bwusageRegion": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegion" } }, "bwusageSite": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySite" } }, "bwusageSiteGateway": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySite" } } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByRegion": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "regionName": { "type": "string", "example": "example string" }, "siteCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageBySite": { "type": "object", "properties": { "edgeCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "locationId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "locationName": { "type": "string", "example": "example string" }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteName": { "type": "string", "example": "example string" }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v1BwtrackerEnterpriseCsvPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerEnterpriseCsvPostResponse": { "type": "object", "properties": { "bwusageCsvDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvDetails" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageCsvDetails": { "type": "object", "properties": { "bwusageCsvRecord": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvRecord" } } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageCsvRecord": { "type": "object", "properties": { "cloudProviderName": { "type": "string", "example": "example string" }, "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "enterpriseId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "regionName": { "type": "string", "example": "example string" }, "serviceType": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeSummaryPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeSummaryPostResponse": { "type": "object", "properties": { "bwusageSummary": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegionEdgeSummary" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByRegionEdgeSummary": { "type": "object", "properties": { "bwusageTopSites": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByTopSites" } }, "edgeusageKbps": { "type": "number", "format": "double", "example": 123.45 }, "percentChanged": { "type": "number", "format": "double", "example": 123.45 }, "siteCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "totusageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByTopSites": { "type": "object", "properties": { "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteName": { "type": "string", "example": "example string" }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeChartPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeChartPostResponse": { "type": "object", "properties": { "bwusageChart": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageChart" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageChart": { "type": "object", "properties": { "bwusageChart": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageChartValue" } }, "percentileUsageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageChartValue": { "type": "object", "properties": { "avgValue": { "type": "number", "format": "double", "example": 123.45 }, "duration": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "maxValue": { "type": "number", "format": "double", "example": 123.45 }, "startTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeDetailsPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeDetailsPostResponse": { "type": "object", "properties": { "bwusageDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegionEdgeDetails" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageByRegionEdgeDetails": { "type": "object", "properties": { "bwuageSites": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySite" } } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeCsvPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionEdgeCsvPostResponse": { "type": "object", "properties": { "bwusageCsvDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvDetails" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewaySummaryPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewaySummaryPostResponse": { "type": "object", "properties": { "bwusageSummary": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegionEdgeSummary" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayChartPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayChartPostResponse": { "type": "object", "properties": { "bwusageChart": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageChart" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayDetailsPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayDetailsPostResponse": { "type": "object", "properties": { "bwusageDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegionEdgeDetails" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayCsvPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionGatewayCsvPostResponse": { "type": "object", "properties": { "bwusageCsvDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvDetails" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteSummaryPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteSummaryPostResponse": { "type": "object", "properties": { "bwusageSummary": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteSummary" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageBySiteSummary": { "type": "object", "properties": { "bwuageRegion": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageByRegion" } }, "edgeCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "providerCount": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v1BwtrackerRegionSiteChartPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteChartPostResponse": { "type": "object", "properties": { "bwusageChart": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageChart" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteDetailsPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteDetailsPostResponse": { "type": "object", "properties": { "bwusageDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteDetails" } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageBySiteDetails": { "type": "object", "properties": { "bwuageEdgeProvider": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteEdgeProvider" } }, "bwuageProvider": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteProvider" } } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageBySiteEdgeProvider": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "deviceName": { "type": "string", "example": "example string" }, "providerId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "providerName": { "type": "string", "example": "example string" }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBandwidthtrackerBwUsageBySiteProvider": { "type": "object", "properties": { "providerId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "providerName": { "type": "string", "example": "example string" }, "usageKbps": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "v1BwtrackerSiteCsvPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerSiteCsvPostResponse": { "type": "object", "properties": { "bwusageCsvDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvDetails" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewaySummaryPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewaySummaryPostResponse": { "type": "object", "properties": { "bwusageSummary": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteSummary" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewayChartPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewayChartPostResponse": { "type": "object", "properties": { "bwusageChart": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageChart" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewayDetailsPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerRegionSiteGatewayDetailsPostResponse": { "type": "object", "properties": { "bwusageDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageBySiteDetails" } }, "additionalProperties": false }, "v1BwtrackerSiteGatewayCsvPostRequest": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "siteId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "timeWindow": { "$ref": "#/components/schemas/statsmonBandwidthtrackerTimeWindow" } }, "additionalProperties": false }, "v1BwtrackerSiteGatewayCsvPostResponse": { "type": "object", "properties": { "bwusageCsvDetails": { "$ref": "#/components/schemas/statsmonBandwidthtrackerBwUsageCsvDetails" } }, "additionalProperties": false }, "v1TroubleshootingEnterprisePostRequest": { "type": "object", "properties": { "dimensions": { "$ref": "#/components/schemas/v1TroubleshootingEnterprisePostRequestDimensions" }, "filter": { "$ref": "#/components/schemas/statsmonTroubleshootingFilter" } }, "additionalProperties": false }, "v1TroubleshootingEnterprisePostRequestDimensions": { "type": "object", "properties": { "certificateExpiry": { "type": "boolean", "example": true }, "coreConnectivity": { "type": "boolean", "example": true }, "coreTransitions": { "type": "boolean", "example": true }, "cpu": { "type": "boolean", "example": true }, "crashes": { "type": "boolean", "example": true }, "creditExpiry": { "type": "boolean", "example": true }, "disk": { "type": "boolean", "example": true }, "fanSpeed": { "type": "boolean", "example": true }, "licenseExpiry": { "type": "boolean", "example": true }, "memory": { "type": "boolean", "example": true }, "odpConnectivity": { "type": "boolean", "example": true }, "odpTransitions": { "type": "boolean", "example": true }, "slaPerformance": { "type": "boolean", "example": true }, "t2Connectivity": { "type": "boolean", "example": true }, "t2Transitions": { "type": "boolean", "example": true }, "temperature": { "type": "boolean", "example": true } }, "additionalProperties": false }, "statsmonTroubleshootingFilter": { "type": "object", "properties": { "circuitNames": { "type": "array", "items": { "type": "string", "example": "example string" } }, "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "lanSegments": { "type": "array", "items": { "type": "string", "example": "example string" } }, "regionIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "siteIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1TroubleshootingEnterprisePostResponse": { "type": "object", "properties": { "sites": { "type": "array", "items": { "$ref": "#/components/schemas/v1TroubleshootingEnterprisePostResponseSiteSummary" } } }, "additionalProperties": false }, "v1TroubleshootingEnterprisePostResponseSiteSummary": { "type": "object", "properties": { "controlStatus": { "type": "string", "example": "ENUM_VALUE" }, "dataStatus": { "type": "string", "example": "ENUM_VALUE" }, "overallStatus": { "type": "string", "example": "ENUM_VALUE" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "selectedStatus": { "type": "string", "example": "ENUM_VALUE" }, "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" }, "systemStatus": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonTroubleshootingRegion": { "type": "object", "properties": { "regionId": { "type": "integer", "format": "int32", "example": 123 }, "regionName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1TroubleshootingSiteSiteIdGetResponse": { "type": "object", "properties": { "edgeStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingEdgeStatus" } }, "siteName": { "type": "string", "example": "example string" }, "siteStatus": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonTroubleshootingEdgeStatus": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "deviceStatus": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1TroubleshootingDeviceDeviceIdPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonTroubleshootingTimeWindow" } }, "additionalProperties": false }, "statsmonTroubleshootingTimeWindow": { "type": "object", "properties": { "bucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1TroubleshootingDeviceDeviceIdPostResponse": { "type": "object", "properties": { "MaintenanceMode": { "type": "boolean", "example": true }, "colrActive": { "type": "boolean", "example": true }, "controlPlane": { "$ref": "#/components/schemas/statsmonTroubleshootingControlPlane" }, "dataPlane": { "$ref": "#/components/schemas/statsmonTroubleshootingDataPlane" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingIssue" } }, "lifecycleStatus": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "swVersion": { "type": "string", "example": "example string" }, "swVersionV2": { "$ref": "#/components/schemas/upgradeSwVersion" }, "systemPlane": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemPlane" }, "upSinceTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonTroubleshootingControlPlane": { "type": "object", "properties": { "controlTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingTransitions" } }, "managementTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingTransitions" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonTroubleshootingTransitions": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } } }, "additionalProperties": false }, "statsmonTroubleshootingSystemStat": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "peerName": { "type": "string", "example": "example string" }, "time": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "value": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonTroubleshootingDataPlane": { "type": "object", "properties": { "downTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingTransitions" } }, "sessionSlas": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSessionSla" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonTroubleshootingSessionSla": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSlaValue" } } }, "additionalProperties": false }, "statsmonTroubleshootingSlaValue": { "type": "object", "properties": { "delayValue": { "type": "number", "format": "double", "example": 123.45 }, "jitterValue": { "type": "number", "format": "double", "example": 123.45 }, "lossValue": { "type": "number", "format": "double", "example": 123.45 }, "status": { "type": "string", "example": "ENUM_VALUE" }, "time": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "value": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonTroubleshootingIssue": { "type": "object", "properties": { "alertId": { "type": "string", "example": "example string" }, "allowListed": { "type": "boolean", "example": true }, "component": { "type": "string", "example": "example string" }, "endTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "entity": { "type": "string", "example": "example string" }, "issue": { "type": "string", "example": "example string" }, "muteListed": { "type": "boolean", "example": true }, "notificationCreated": { "type": "boolean", "example": true }, "plane": { "type": "string", "example": "example string" }, "reason": { "type": "string", "example": "example string" }, "severity": { "type": "string", "example": "ENUM_VALUE" }, "startTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonTroubleshootingSystemPlane": { "type": "object", "properties": { "cpu": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "crashes": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingCrash" } }, "disk": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "lastCrash": { "$ref": "#/components/schemas/statsmonTroubleshootingLastCrash" }, "maintenanceWindows": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingMaintenanceWindow" } }, "memory": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "status": { "type": "string", "example": "ENUM_VALUE" }, "temperature": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingOverheating" } }, "temperatureSeries": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } } }, "additionalProperties": false }, "statsmonTroubleshootingCrash": { "type": "object", "properties": { "time": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonTroubleshootingLastCrash": { "type": "object", "properties": { "crashDetails": { "type": "string", "example": "example string" }, "reason": { "type": "string", "example": "example string" }, "upSinceTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonTroubleshootingMaintenanceWindow": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonTroubleshootingTimeWindow" } }, "additionalProperties": false }, "statsmonTroubleshootingOverheating": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonTroubleshootingTimeWindow" } }, "additionalProperties": false }, "v1TroubleshootingFilterGetResponse": { "type": "object", "properties": { "circuits": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingCircuitFilter" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingDeviceFilter" } }, "lanSegments": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingLanSegmentFilter" } }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingRegionFilter" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSiteFilter" } } }, "additionalProperties": false }, "statsmonTroubleshootingCircuitFilter": { "type": "object", "properties": { "circuitName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonTroubleshootingDeviceFilter": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonTroubleshootingLanSegmentFilter": { "type": "object", "properties": { "lanSegment": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonTroubleshootingRegionFilter": { "type": "object", "properties": { "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" } }, "additionalProperties": false }, "statsmonTroubleshootingSiteFilter": { "type": "object", "properties": { "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1TroubleshootingTopSitesByAlertsPostRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/statsmonTroubleshootingFilter" } }, "additionalProperties": false }, "v1TroubleshootingTopSitesByAlertsPostResponse": { "type": "object", "properties": { "controlPlane": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostResponseSiteCounts" }, "dataPlane": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostResponseSiteCounts" }, "systemPlane": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostResponseSiteCounts" } }, "additionalProperties": false }, "v1TroubleshootingTopSitesByAlertsPostResponseSiteCounts": { "type": "object", "properties": { "siteCounts": { "type": "array", "items": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostResponseSiteCountsSiteCount" } } }, "additionalProperties": false }, "v1TroubleshootingTopSitesByAlertsPostResponseSiteCountsSiteCount": { "type": "object", "properties": { "numAlerts": { "type": "integer", "format": "int32", "example": 123 }, "siteName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1TroubleshootingSiteConnectivityStatusGetResponse": { "type": "object", "properties": { "connectivityStatus": { "type": "array", "items": { "$ref": "#/components/schemas/v1TroubleshootingSiteConnectivityStatusGetResponseSiteStatus" } } }, "additionalProperties": false }, "v1TroubleshootingSiteConnectivityStatusGetResponseSiteStatus": { "type": "object", "properties": { "siteId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1BackboneHealthOverviewPostRequest": { "type": "object", "properties": { "dimensions": { "$ref": "#/components/schemas/v1BackboneHealthOverviewPostRequestDimensions" }, "filter": { "$ref": "#/components/schemas/statsmonTroubleshootingFilter" } }, "additionalProperties": false }, "v1BackboneHealthOverviewPostRequestDimensions": { "type": "object", "properties": { "certificateExpiry": { "type": "boolean", "example": true }, "coreConnectivity": { "type": "boolean", "example": true }, "coreCoreSlaPerformance": { "type": "boolean", "example": true }, "coreWanPerformance": { "type": "boolean", "example": true }, "cpu": { "type": "boolean", "example": true }, "crashes": { "type": "boolean", "example": true }, "creditExpiry": { "type": "boolean", "example": true }, "disk": { "type": "boolean", "example": true }, "fanSpeed": { "type": "boolean", "example": true }, "licenseExpiry": { "type": "boolean", "example": true }, "memory": { "type": "boolean", "example": true }, "odpConnectivity": { "type": "boolean", "example": true }, "t2Connectivity": { "type": "boolean", "example": true }, "temperature": { "type": "boolean", "example": true } }, "additionalProperties": false }, "v1BackboneHealthOverviewPostResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthOverviewPostResponseDeviceSummary" } } }, "additionalProperties": false }, "v1BackboneHealthOverviewPostResponseDeviceSummary": { "type": "object", "properties": { "controlStatus": { "type": "string", "example": "ENUM_VALUE" }, "dataStatus": { "type": "string", "example": "ENUM_VALUE" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "deviceRole": { "type": "string", "example": "ENUM_VALUE" }, "overallStatus": { "type": "string", "example": "ENUM_VALUE" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "selectedStatus": { "type": "string", "example": "ENUM_VALUE" }, "systemStatus": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1BackboneHealthDeviceDeviceIdPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonTroubleshootingTimeWindow" } }, "additionalProperties": false }, "v1BackboneHealthDeviceDeviceIdPostResponse": { "type": "object", "properties": { "controlPlane": { "$ref": "#/components/schemas/statsmonBackbonehealthControlPlane" }, "dataPlane": { "$ref": "#/components/schemas/statsmonBackbonehealthDataPlane" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingIssue" } }, "qoeMatrix": { "$ref": "#/components/schemas/statsmonBackbonehealthGetQoeMatrixResponse" }, "role": { "type": "string", "example": "ENUM_VALUE" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "swVersion": { "type": "string", "example": "example string" }, "swVersionV2": { "$ref": "#/components/schemas/upgradeSwVersion" }, "systemPlane": { "$ref": "#/components/schemas/statsmonBackbonehealthSystemPlane" }, "upSinceTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonBackbonehealthControlPlane": { "type": "object", "properties": { "controlTransitions": { "$ref": "#/components/schemas/statsmonBackbonehealthTransitionSeries" }, "managementTransitions": { "$ref": "#/components/schemas/statsmonBackbonehealthTransitionSeries" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonBackbonehealthTransitionSeries": { "type": "object", "properties": { "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBackbonehealthTransitions" } } }, "additionalProperties": false }, "statsmonBackbonehealthTransitions": { "type": "object", "properties": { "name": { "type": "string", "example": "example string" }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } } }, "additionalProperties": false }, "statsmonBackbonehealthDataPlane": { "type": "object", "properties": { "downTransitions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBackbonehealthTransitions" } }, "sessionSlas": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSessionSla" } }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonBackbonehealthGetQoeMatrixResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBackbonehealthGetQOEMatrixResponseDevicesSummary" } }, "qoeMatrix": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBackbonehealthGetQOEMatrixResponseQoeSessionSummary" } } }, "additionalProperties": false }, "statsmonBackbonehealthGetQOEMatrixResponseDevicesSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" } }, "additionalProperties": false }, "statsmonBackbonehealthGetQOEMatrixResponseQoeSessionSummary": { "type": "object", "properties": { "box": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonBackbonehealthGetQOEMatrixResponseQoeSessionSummaryQoeSessionBox" } }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceRegion": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "peerDeviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "peerDeviceRegion": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "sessionName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonBackbonehealthGetQOEMatrixResponseQoeSessionSummaryQoeSessionBox": { "type": "object", "properties": { "delayValue": { "type": "number", "format": "double", "example": 123.45 }, "endTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "jitterValue": { "type": "number", "format": "double", "example": 123.45 }, "lossValue": { "type": "number", "format": "double", "example": 123.45 }, "startTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "status": { "type": "string", "example": "ENUM_VALUE" }, "value": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "statsmonBackbonehealthSystemPlane": { "type": "object", "properties": { "cpu": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "crashes": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingCrash" } }, "disk": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "lastCrash": { "$ref": "#/components/schemas/statsmonTroubleshootingLastCrash" }, "maintenanceWindows": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingMaintenanceWindow" } }, "memory": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } }, "overheating": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingOverheating" } }, "status": { "type": "string", "example": "ENUM_VALUE" }, "temperatureSeries": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSystemStat" } } }, "additionalProperties": false }, "v1BackboneHealthFilterGetResponse": { "type": "object", "properties": { "circuits": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingCircuitFilter" } }, "devices": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingDeviceFilter" } }, "lanSegments": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingLanSegmentFilter" } }, "regions": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingRegionFilter" } }, "sites": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonTroubleshootingSiteFilter" } } }, "additionalProperties": false }, "v1BackboneHealthTopDevicesByAlertsPostRequest": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/statsmonTroubleshootingFilter" } }, "additionalProperties": false }, "v1BackboneHealthTopDevicesByAlertsPostResponse": { "type": "object", "properties": { "controlPlane": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCounts" }, "dataPlane": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCounts" }, "systemPlane": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCounts" } }, "additionalProperties": false }, "v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCounts": { "type": "object", "properties": { "deviceCounts": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCountsDeviceCount" } } }, "additionalProperties": false }, "v1BackboneHealthTopDevicesByAlertsPostResponseDeviceCountsDeviceCount": { "type": "object", "properties": { "deviceName": { "type": "string", "example": "example string" }, "numAlerts": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v1BackboneHealthEtetSlaMatrixGetResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthEtetSlaMatrixGetResponseDevicesSummary" } }, "regionStatus": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthEtetSlaMatrixGetResponseRegionStatus" } }, "slaMatrix": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthEtetSlaMatrixGetResponseSlaSummary" } } }, "additionalProperties": false }, "v1BackboneHealthEtetSlaMatrixGetResponseDevicesSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" } }, "additionalProperties": false }, "v1BackboneHealthEtetSlaMatrixGetResponseRegionStatus": { "type": "object", "properties": { "peerRegion": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1BackboneHealthEtetSlaMatrixGetResponseSlaSummary": { "type": "object", "properties": { "delayStatus": { "type": "string", "example": "ENUM_VALUE" }, "delayValue": { "type": "number", "format": "float", "example": 12.34 }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "jitterStatus": { "type": "string", "example": "ENUM_VALUE" }, "jitterValue": { "type": "number", "format": "float", "example": 12.34 }, "lossStatus": { "type": "string", "example": "ENUM_VALUE" }, "lossValue": { "type": "number", "format": "float", "example": 12.34 }, "mosValue": { "type": "number", "format": "float", "example": 12.34 }, "peerDeviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "peerDeviceName": { "type": "string", "example": "example string" }, "peerRegion": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1BackboneHealthEtWanMatrixGetResponse": { "type": "object", "properties": { "deviceEtwanSummary": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthEtWanMatrixGetResponseDeviceEtWanSummary" } }, "regionSlaStatus": { "type": "array", "items": { "$ref": "#/components/schemas/v1BackboneHealthEtWanMatrixGetResponseRegionStatus" } } }, "additionalProperties": false }, "v1BackboneHealthEtWanMatrixGetResponseDeviceEtWanSummary": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "deviceName": { "type": "string", "example": "example string" }, "provider": { "type": "string", "example": "example string" }, "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1BackboneHealthEtWanMatrixGetResponseRegionStatus": { "type": "object", "properties": { "region": { "$ref": "#/components/schemas/statsmonTroubleshootingRegion" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v2SiteSiteIdLanSegmentsPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2SiteSiteIdLanSegmentsPostResponse": { "type": "object", "properties": { "deviceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2DeviceSegments" } } }, "additionalProperties": false }, "statsmonV2DeviceSegments": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "vrfRoutes": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2VrfRoutes" } } }, "additionalProperties": false }, "statsmonV2VrfRoutes": { "type": "object", "properties": { "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "vrfRoute": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2VrfRoute" } } }, "additionalProperties": false }, "statsmonV2VrfRoute": { "type": "object", "properties": { "ipv4Routes": { "type": "integer", "format": "int64", "example": 1234567891011 }, "ipv6Routes": { "type": "integer", "format": "int64", "example": 1234567891011 }, "totalRoutes": { "type": "integer", "format": "int64", "example": 1234567891011 }, "vrfName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2DeviceDeviceIdLanSegmentsPostRequest": { "type": "object", "properties": { "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2DeviceDeviceIdLanSegmentsPostResponse": { "type": "object", "properties": { "deviceSegments": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2DeviceSegments" } } }, "additionalProperties": false }, "v2SiteSiteIdTopologyPostRequest": { "type": "object", "properties": { "snapshotTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" } }, "additionalProperties": false }, "v2SiteSiteIdTopologyPostResponse": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2Edge" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2Node" } }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/v2SiteSiteIdTopologyPostResponseSnapshot" } } }, "additionalProperties": false }, "statsmonV2Edge": { "type": "object", "properties": { "a": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "b": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "circuitsInfo": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2EdgeedgeCircuitInfo" } }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2Connection" } }, "name": { "type": "string", "example": "example string" }, "quality": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonV2EdgeedgeCircuitInfo": { "type": "object", "properties": { "circuitCarrier": { "type": "string", "example": "example string" }, "circuitName": { "type": "string", "example": "example string" }, "deviceHostname": { "type": "string", "example": "example string" }, "interfaceName": { "type": "string", "example": "example string" }, "label": { "type": "string", "example": "ENUM_VALUE" }, "lastResortCircuit": { "type": "boolean", "example": true }, "quality": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "sourcePublicIp": { "type": "string", "example": "example string" }, "uptime": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "statsmonV2Connection": { "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "circuitCarrier": { "type": "string", "example": "example string" }, "circuitName": { "type": "string", "example": "example string" }, "destinationIp": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" }, "lastEstablishedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lastResort": { "type": "boolean", "example": true }, "quality": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "sourcePublicIp": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonV2Node": { "type": "object", "properties": { "circuitInfo": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2NodeCircuitInfo" } }, "connections": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2NodeConnection" } }, "id": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "nodeInfo": { "$ref": "#/components/schemas/statsmonV2NodeDeviceInfo" }, "preferredRegionName": { "type": "string", "example": "example string" }, "quality": { "type": "string", "example": "ENUM_VALUE" }, "type": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonV2NodeCircuitInfo": { "type": "object", "properties": { "averageDownlinkUtilization": { "type": "number", "format": "double", "example": 123.45 }, "averageUplinkUtilization": { "type": "number", "format": "double", "example": 123.45 }, "circuitCarrier": { "type": "string", "example": "example string" }, "circuitName": { "type": "string", "example": "example string" }, "connectedRegionName": { "type": "string", "example": "example string" }, "currentDownlinkUtilization": { "type": "number", "format": "double", "example": 123.45 }, "currentUplinkUtilization": { "type": "number", "format": "double", "example": 123.45 }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "interfaceName": { "type": "string", "example": "example string" }, "jitter": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "label": { "type": "string", "example": "ENUM_VALUE" }, "lastResort": { "type": "boolean", "example": true }, "latency": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "loss": { "type": "number", "format": "float", "example": 12.34 }, "qoe": { "type": "number", "format": "float", "example": 12.34 }, "quality": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "statsmonV2NodeConnection": { "type": "object", "properties": { "active": { "type": "boolean", "example": true }, "circuitCarrier": { "type": "string", "example": "example string" }, "circuitName": { "type": "string", "example": "example string" }, "destinationIp": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" }, "lastEstablishedTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "lastResort": { "type": "boolean", "example": true }, "quality": { "type": "string", "example": "ENUM_VALUE" }, "sourceIp": { "type": "string", "example": "example string" }, "sourcePublicIp": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "statsmonV2NodeDeviceInfo": { "type": "object", "properties": { "controlQuality": { "type": "string", "example": "ENUM_VALUE" }, "cpu": { "type": "number", "format": "float", "example": 12.34 }, "dataQuality": { "type": "string", "example": "ENUM_VALUE" }, "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "hostname": { "type": "string", "example": "example string" }, "location": { "type": "string", "example": "example string" }, "maintenanceMode": { "type": "boolean", "example": true }, "memory": { "type": "number", "format": "float", "example": 12.34 }, "mgmtIp": { "type": "string", "example": "example string" }, "model": { "type": "string", "example": "example string" }, "portalQuality": { "type": "string", "example": "ENUM_VALUE" }, "serialNumber": { "type": "string", "example": "example string" }, "softwareVersion": { "type": "string", "example": "example string" }, "stagingMode": { "type": "boolean", "example": true }, "temperature": { "type": "number", "format": "float", "example": 12.34 }, "uptime": { "$ref": "#/components/schemas/googleProtobufDuration" } }, "additionalProperties": false }, "v2SiteSiteIdTopologyPostResponseSnapshot": { "type": "object", "properties": { "quality": { "type": "string", "example": "ENUM_VALUE" }, "snapshotTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2DeviceDeviceIdTopologyPostRequest": { "type": "object", "properties": { "snapshotTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "timeWindow": { "$ref": "#/components/schemas/statsmonV2TimeWindow" }, "version": { "type": "integer", "format": "int32", "example": 123 } }, "additionalProperties": false }, "v2DeviceDeviceIdTopologyPostResponse": { "type": "object", "properties": { "edges": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2Edge" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonV2Node" } }, "snapshots": { "type": "array", "items": { "$ref": "#/components/schemas/v2DeviceDeviceIdTopologyPostResponseSnapshot" } } }, "additionalProperties": false }, "v2DeviceDeviceIdTopologyPostResponseSnapshot": { "type": "object", "properties": { "quality": { "type": "string", "example": "ENUM_VALUE" }, "snapshotTime": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2MonitoringSegmentRouteCountsPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } }, "additionalProperties": false }, "v2MonitoringSegmentRouteCountsPostResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringSegmentRouteCountsPostResponseData" } } }, "additionalProperties": false }, "v2MonitoringSegmentRouteCountsPostResponseData": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "ipv4RouteCount": { "$ref": "#/components/schemas/statsmonV2StatsSample" }, "ipv6RouteCount": { "$ref": "#/components/schemas/statsmonV2StatsSample" }, "segmentName": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v2MonitoringExtranetServiceStatusGetResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetServerStatus" } } }, "additionalProperties": false }, "statsmonExtranetServerStatus": { "type": "object", "properties": { "address": { "type": "string", "example": "192.168.1.1", "description": "the IP address of the server" }, "status": { "type": "string", "example": "Healthy", "description": "the health status of the server (Healthy, Impaired, Down)" } }, "additionalProperties": false }, "v2MonitoringExtranetSiteStatusGetResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetSiteStatus" } } }, "additionalProperties": false }, "statsmonExtranetSiteStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id of the site" }, "name": { "type": "string", "example": "site1", "description": "the name of the site" }, "status": { "type": "string", "example": "Healthy", "description": "the status of the site (Healthy, Impaired, Down)" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetServerStatus" } } }, "additionalProperties": false }, "v2MonitoringExtranetServiceStatusDetailsGetResponse": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetSiteStatus" } } }, "additionalProperties": false }, "v2MonitoringExtranetStatusDetailsGetResponse": { "type": "object", "properties": { "edgeStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetEdgeStatus" } }, "location": { "type": "string", "example": "Location 1", "description": "the location of the site" }, "region": { "type": "string", "example": "Region 1", "description": "the region of the site" }, "siteStatus": { "$ref": "#/components/schemas/statsmonExtranetSiteStatus" } }, "additionalProperties": false }, "statsmonExtranetEdgeStatus": { "type": "object", "properties": { "createdAt": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "disconnectedReason": { "type": "string", "example": "No route to the server", "description": "the reason for the edge being disconnected" }, "hostname": { "type": "string", "example": "edge1", "description": "the hostname of the edge" }, "id": { "type": "integer", "format": "int64", "example": 30000000001, "description": "the id of the edge/device" }, "siteName": { "type": "string", "example": "site1", "description": "the name of the site" }, "status": { "type": "string", "example": "Healthy", "description": "the health status of the edge (Healthy, Impaired, Down)" } }, "additionalProperties": false }, "v2MonitoringExtranetLogDetailsPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service (required)" }, "isB2B": { "type": "boolean", "example": true, "description": "whether the entity is a b2b entity (true for b2b entity, false for local extranet entity) (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider or consumer (required)" } }, "additionalProperties": false, "required": [ "id", "isB2B", "isProvider" ] }, "v2MonitoringExtranetLogDetailsPostResponse": { "type": "object", "properties": { "logs": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringExtranetLogDetailsPostResponseLogDetails" } } }, "additionalProperties": false }, "v2MonitoringExtranetLogDetailsPostResponseLogDetails": { "type": "object", "properties": { "hostname": { "type": "string", "example": "hostname1", "description": "the hostname of the log" }, "reason": { "type": "string", "example": "Reason 1", "description": "the reason for the log" }, "serverAddress": { "type": "string", "example": "192.168.1.1", "description": "the address of the server" }, "siteName": { "type": "string", "example": "site1", "description": "the name of the site" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v2MonitoringExtranetEdgeStatusGetResponse": { "type": "object", "properties": { "edgeStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetEdgeStatus" } } }, "additionalProperties": false }, "v1ExtranetB2bMonitoringPeeringServiceServiceHealthPostRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1, "description": "the id of the service (required)" }, "isProvider": { "type": "boolean", "example": true, "description": "whether the entity is a provider/producer or consumer (required)" } }, "additionalProperties": false, "required": [ "id", "isProvider" ] }, "v1ExtranetB2bMonitoringPeeringServiceServiceHealthPostResponse": { "type": "object", "properties": { "serviceHealth": { "type": "array", "items": { "$ref": "#/components/schemas/statsmonExtranetServiceHealth" } } }, "additionalProperties": false }, "statsmonExtranetServiceHealth": { "type": "object", "properties": { "customerName": { "type": "string", "example": "Customer 1", "description": "the name of the customer" }, "customerPrefixHealth": { "$ref": "#/components/schemas/statsmonExtranetPrefixHealth" }, "overallHealth": { "type": "string", "example": "Impaired", "description": "the overall connectivity status of the service (Healthy, Impaired, Down)" }, "producerPrefixHealth": { "$ref": "#/components/schemas/statsmonExtranetPrefixHealth" } }, "additionalProperties": false }, "statsmonExtranetPrefixHealth": { "type": "object", "properties": { "health": { "type": "string", "example": "Impaired", "description": "the health status of the prefix (Healthy, Impaired, Down)" }, "missingPrefixes": { "type": "array", "items": { "type": "string", "example": "192.168.0.0/16", "description": "a list of the missing producer or consumer prefixes (in Impaired state)" } } }, "additionalProperties": false }, "v2MonitoringMacsecDeviceIdStatusGetResponse": { "type": "object", "properties": { "macsecStatuses": { "type": "array", "items": { "$ref": "#/components/schemas/v2MonitoringMacsecDeviceIdStatusGetResponseMaCsecStatus" } } }, "additionalProperties": false }, "v2MonitoringMacsecDeviceIdStatusGetResponseMaCsecStatus": { "type": "object", "properties": { "interfaceName": { "type": "string", "example": "example string" }, "status": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1LogsPostRequest": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "customerView": { "type": "boolean", "example": true }, "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "histogramBucketSizeSec": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "numLogs": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "oldTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "recentTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/syslogmonSyslogsSelector" } } }, "additionalProperties": false }, "syslogmonSyslogsSelector": { "type": "object", "properties": { "field": { "type": "string", "example": "ENUM_VALUE" }, "values": { "type": "array", "items": { "type": "string", "example": "example string" } } }, "additionalProperties": false }, "v1LogsPostResponse": { "type": "object", "properties": { "cursorRef": { "type": "string", "example": "example string" }, "histogram": { "type": "array", "items": { "$ref": "#/components/schemas/syslogmonHistogram" } }, "logs": { "type": "array", "items": { "$ref": "#/components/schemas/syslogmonLog" } }, "totalLogs": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, "additionalProperties": false }, "syslogmonHistogram": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "syslogmonLog": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "facility": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" }, "level": { "type": "string", "example": "ENUM_VALUE" }, "message": { "type": "string", "example": "example string" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "v1DevicesUpgradeSchedulePutRequest": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } }, "deviceVersions": { "type": "array", "items": { "$ref": "#/components/schemas/v1DevicesUpgradeSchedulePutRequestDeviceVersion" } }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "version": { "$ref": "#/components/schemas/upgradeSwVersion" } }, "additionalProperties": false }, "v1DevicesUpgradeSchedulePutRequestDeviceVersion": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "version": { "$ref": "#/components/schemas/upgradeSwVersion" } }, "additionalProperties": false }, "v1DevicesUpgradeCancelPutRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1SoftwareReleasesSummaryGetResponse": { "type": "object", "properties": { "summaries": { "type": "array", "items": { "$ref": "#/components/schemas/upgradeReleaseSummary" } } }, "additionalProperties": false }, "upgradeReleaseSummary": { "type": "object", "properties": { "eosTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "key": { "$ref": "#/components/schemas/upgradeInventoryKey" }, "name": { "type": "string", "example": "example string" }, "release": { "type": "string", "example": "ENUM_VALUE" }, "releaseTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "upgradeInventoryKey": { "type": "object", "properties": { "model": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "version": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1DevicesRunningVersionPostRequest": { "type": "object", "properties": { "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 } } }, "additionalProperties": false }, "v1DevicesRunningVersionPostResponse": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/upgradeRunningSwVersion" } } }, "additionalProperties": false }, "upgradeRunningSwVersion": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "version": { "$ref": "#/components/schemas/upgradeSwVersion" } }, "additionalProperties": false }, "v1SoftwareGcsreleaseUploadNotesPostRequest": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/upgradeGcsReleaseDetails" } }, "additionalProperties": false }, "upgradeGcsReleaseDetails": { "type": "object", "properties": { "category": { "type": "array", "items": { "$ref": "#/components/schemas/upgradeGcsReleaseCategory" } }, "major": { "type": "boolean", "example": true }, "releaseTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false }, "upgradeGcsReleaseCategory": { "type": "object", "properties": { "content": { "type": "string", "example": "example string" }, "title": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1SoftwareGcsreleaseUploadNotesPostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1SoftwareReleasesDownloadGetResponse": { "type": "object", "properties": { "imageLink": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1SoftwareRunningSummaryGetResponse": { "type": "object", "properties": { "versions": { "type": "array", "items": { "$ref": "#/components/schemas/v1SoftwareRunningSummaryGetResponseVersionSummary" } } }, "additionalProperties": false }, "v1SoftwareRunningSummaryGetResponseVersionSummary": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "name": { "type": "string", "example": "example string" }, "version": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1SoftwareRunningDetailsGetResponse": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/v1SoftwareRunningDetailsGetResponseDevice" } } }, "additionalProperties": false }, "v1SoftwareRunningDetailsGetResponseDevice": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011 }, "enterpriseName": { "type": "string", "example": "example string" }, "hostname": { "type": "string", "example": "example string" } }, "additionalProperties": false }, "v1SoftwareAutoUpgradeDefaultPutRequest": { "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/upgradeUpgradeCanaryProfile" }, "release": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "upgradeUpgradeCanaryProfile": { "type": "object", "properties": { "action": { "type": "string", "example": "ENUM_VALUE" }, "name": { "type": "string", "example": "example string" }, "occurrence": { "$ref": "#/components/schemas/upgradeUpgradeOccurrence" }, "release": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "upgradeUpgradeOccurrence": { "type": "object", "properties": { "dayOfWeek": { "type": "string", "example": "ENUM_VALUE" }, "hour": { "type": "integer", "format": "int32", "example": 123 }, "minute": { "type": "integer", "format": "int32", "example": 123 }, "occurrenceInMonth": { "type": "integer", "format": "int32", "example": 123 }, "ordinal": { "type": "string", "example": "ENUM_VALUE" }, "weekday": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1SoftwareAutoUpgradeDefaultGetResponse": { "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/upgradeUpgradeCanaryProfile" }, "release": { "type": "string", "example": "ENUM_VALUE" } }, "additionalProperties": false }, "v1SoftwareRolloutsPostRequest": { "type": "object", "properties": { "rolloutConfig": { "$ref": "#/components/schemas/upgradeRolloutConfig" } }, "additionalProperties": false, "required": [ "rolloutConfig" ] }, "upgradeRolloutConfig": { "type": "object", "properties": { "action": { "type": "string", "example": "InstallActivate", "description": "Upgrade action to perform (e.g. install+activate, install only, activate, auto-upgrade). (required)" }, "description": { "type": "string", "example": "Upgrade branch sites to release 25.4", "description": "Optional longer description of the rollout." }, "deviceIds": { "type": "array", "items": { "type": "integer", "format": "int64", "example": "1001,1002,1003", "description": "Device IDs included in the rollout (field name retained for API compatibility)." } }, "name": { "type": "string", "example": "Q2 edge upgrade", "description": "Human-readable rollout name unique within the enterprise. (required)" }, "release": { "type": "string", "example": "Recommended", "description": "Target software release for devices in this rollout. (required)" }, "schedule": { "$ref": "#/components/schemas/upgradeRecurringSchedule" } }, "additionalProperties": false, "required": [ "action", "name", "release" ] }, "upgradeRecurringSchedule": { "type": "object", "properties": { "monthly": { "$ref": "#/components/schemas/upgradeMonthlyRecurrence" }, "startsAtTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "weekly": { "$ref": "#/components/schemas/upgradeWeeklyRecurrence" }, "yearly": { "$ref": "#/components/schemas/upgradeYearlyRecurrence" } }, "additionalProperties": false, "required": [ "startsAtTs" ] }, "upgradeMonthlyRecurrence": { "type": "object", "properties": { "date": { "type": "integer", "format": "int32", "example": 15, "minimum": 0, "description": "Calendar day of month (1–31) for fixed-date monthly recurrence; optional if ordinal and weekday are set." }, "ordinal": { "type": "string", "example": "Second", "description": "For nth-weekday-of-month style recurrence; use together with weekday, or use date instead." }, "weekday": { "type": "string", "example": "Tuesday", "description": "Weekday paired with ordinal for monthly nth-weekday recurrence; optional if date is set." } }, "additionalProperties": false }, "upgradeWeeklyRecurrence": { "type": "object", "properties": { "interval": { "type": "integer", "format": "int32", "example": 2, "minimum": 0, "description": "Which occurrence of the weekday in the month applies for weekly-style recurrence (1–52, aligned with schedule validation). (required)" }, "weekday": { "type": "string", "example": "Monday", "description": "Day of week for the weekly recurrence. (required)" } }, "additionalProperties": false, "required": [ "interval", "weekday" ] }, "upgradeYearlyRecurrence": { "type": "object", "properties": { "date": { "type": "integer", "format": "int32", "example": 1, "minimum": 0, "description": "Calendar day (1–31) for fixed month+date yearly recurrence." }, "month": { "type": "integer", "format": "int32", "example": 3, "minimum": 0, "description": "Month of year (1–12) for yearly recurrence. (required)" }, "ordinal": { "type": "string", "example": "First", "description": "For nth-weekday-in-month yearly recurrence; use with weekday, or use month + date." }, "weekday": { "type": "string", "example": "Wednesday", "description": "Weekday paired with ordinal for yearly recurrence." } }, "additionalProperties": false, "required": [ "month" ] }, "v1SoftwareRolloutsPostResponse": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 42, "description": "Identifier of the created rollout. (required)" } }, "additionalProperties": false }, "v1SoftwareRolloutsPutRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 42, "description": "Rollout identifier to update. (required)" }, "rolloutConfig": { "$ref": "#/components/schemas/upgradeRolloutConfig" } }, "additionalProperties": false, "required": [ "id", "rolloutConfig" ] }, "v1SoftwareRolloutsPutResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1SoftwareRolloutsGetResponse": { "type": "object", "properties": { "rollouts": { "type": "array", "items": { "$ref": "#/components/schemas/upgradeRollout" } } }, "additionalProperties": false }, "upgradeRollout": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/upgradeRolloutDevice" } }, "hasFailed": { "type": "boolean", "example": true, "description": "True if any device in the rollout has a failed upgrade state." }, "id": { "type": "integer", "format": "int64", "example": 42, "description": "Server-assigned rollout identifier." }, "lastRunTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "nextRunTs": { "$ref": "#/components/schemas/googleProtobufTimestamp" }, "numDevices": { "type": "integer", "format": "int32", "example": 3, "description": "Count of devices associated with the rollout." }, "rolloutConfig": { "$ref": "#/components/schemas/upgradeRolloutConfig" }, "status": { "type": "string", "example": "idle", "description": "Status of the upgrade rollout group" } }, "additionalProperties": false }, "upgradeRolloutDevice": { "type": "object", "properties": { "deviceId": { "type": "integer", "format": "int64", "example": 1001, "description": "Device identifier. (required)" }, "hostname": { "type": "string", "example": "edge-site-01", "description": "Device hostname for display." } }, "additionalProperties": false }, "v1SoftwareRolloutsIdGetResponse": { "type": "object", "properties": { "rollout": { "$ref": "#/components/schemas/upgradeRollout" } }, "additionalProperties": false }, "v1SoftwareRolloutsIdDeleteResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1SoftwareRolloutsSchedulePostRequest": { "type": "object", "properties": { "failedOnly": { "type": "boolean", "example": true, "description": "When true, only devices previously marked failed are rescheduled." }, "id": { "type": "integer", "format": "int64", "example": 42, "description": "Rollout identifier to schedule. (required)" }, "ts": { "$ref": "#/components/schemas/googleProtobufTimestamp" } }, "additionalProperties": false, "required": [ "id" ] }, "v1SoftwareRolloutsSchedulePostResponse": { "type": "object", "properties": {}, "additionalProperties": false }, "v1AuthLoginPreGetResponse": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "SSO", "PASSWORD" ], "example": "PASSWORD", "description": "Authentication method to use" }, "email": { "type": "string", "example": "user@example.com", "description": "User email address" }, "iam": { "type": "string", "example": "Azure", "description": "Identity provider name (Azure/Okta)" }, "relayState": { "type": "string", "example": "information-to-relay", "description": "State to relay after authentication" }, "entryPoint": { "type": "string", "example": "https://saml.example.com/sso", "description": "SSO entry point URL" } }, "required": [ "method", "email" ] }, "v1AuthUserGetResponse": { "type": "object", "properties": { "userId": { "type": "string", "example": "user-12345", "description": "User identifier" }, "enterpriseId": { "type": "integer", "format": "int64", "example": 1234567891011, "description": "Enterprise identifier" }, "permissions": { "$ref": "#/components/schemas/authPermissions" }, "timeZone": { "type": "string", "example": "America/New_York", "description": "User timezone" } }, "required": [ "userId", "enterpriseId", "permissions", "timeZone" ] }, "v1AuthLoginPostRequest": { "type": "object", "properties": { "username": { "type": "string", "example": "user@example.com" }, "password": { "type": "string", "example": "password123" } }, "required": [ "username", "password" ] }, "v1AuthLoginPostResponse": { "type": "object", "properties": { "auth": { "type": "boolean", "example": true }, "token": { "type": "string", "example": "gr-auth-12345678-1234-1234-1234-123456789012-87654321-4321-4321-4321-210987654321" }, "accountType": { "type": "string", "enum": [ "no_account", "enterprise", "provider", "msp", "graphiant" ], "example": "enterprise" }, "email": { "type": "string", "example": "user@example.com", "description": "User email address (returned for MFA users)" }, "mfaType": { "type": "string", "example": "TOTP", "description": "MFA type (returned for MFA users)" }, "stateToken": { "type": "string", "example": "state-token-12345", "description": "State token for MFA verification (returned for MFA users)" }, "status": { "type": "string", "example": "AwaitingMfa", "description": "Authentication status (returned for MFA users)" } } }, "v1AuthLoginTempPostRequest": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com" }, "tempPassword": { "type": "string", "example": "temp123456" }, "matchId": { "type": "number", "example": 12345 } }, "required": [ "email", "tempPassword", "matchId" ] }, "v1AuthLoginCallbackPostRequest": { "type": "object", "properties": { "SAMLResponse": { "type": "string", "example": "PHNhbWxwOlJlc3BvbnNl..." }, "RelayState": { "type": "string", "example": "information-to-relay" } }, "required": [ "SAMLResponse" ] }, "v1AuthErrorPostResponse": { "type": "object", "properties": { "auth": { "type": "boolean", "example": false }, "token": { "type": "string", "nullable": true, "example": null }, "error": { "type": "string", "example": "email not provided" } }, "required": [ "auth", "token", "error" ] }, "v1AuthGcsPostRequest": { "type": "object", "properties": { "gcsName": { "type": "string", "example": "my-gcs-instance" }, "apiKey": { "type": "string", "example": "api-key-12345" } }, "required": [ "gcsName", "apiKey" ] }, "v1AuthMfaPostRequest": { "type": "object", "properties": { "email": { "type": "string", "example": "user@example.com" }, "mfaType": { "type": "string", "example": "TOTP" }, "code": { "type": "string", "example": 123456 }, "stateToken": { "type": "string", "example": "state-token-12345" } }, "required": [ "email", "mfaType", "code" ] }, "v1AuthRefreshGetEntryPointResponse": { "type": "object", "properties": { "entryPoint": { "type": "string", "example": "https://saml.example.com/sso" } } }, "authPermissions": { "type": "object", "properties": { "billingAndInvoicing": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "licensing": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "orderStatus": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" }, "support": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" }, "userAndTenantManagement": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "assetManager": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "globalServices": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" }, "networkConfigurations": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "safetyAndSecurity": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "servicePolicies": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "compliance": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" }, "developerTools": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" }, "insights": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "logs": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "monitoringAndTroubleshooting": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read_write" }, "reports": { "type": "string", "enum": [ "none", "read", "read_write" ], "example": "read" } } } } }, "security": [ { "jwtAuth": [] } ], "paths": { "/v2/allowlist/create": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistCreatePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistCreatePostResponse" } } } } } } }, "/v2/integration/": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationPostResponse" } } } } } } }, "/v2/notificationmutelist/create": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationmutelistCreatePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationmutelistCreatePostResponse" } } } } } } }, "/v2/notification/create": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationCreatePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationCreatePostResponse" } } } } } } }, "/v2/ack/createupdate": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AckCreateupdatePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AckCreateupdatePostResponse" } } } } } } }, "/v2/allowlist/deletebyalertid/{alertId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "alertId", "in": "path", "required": true, "description": "Alert id of the alert to delete allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistDeletebyalertidAlertIdDeleteResponse" } } } } } } }, "/v2/allowlist/deletebyentityid/{entityId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "entityId", "in": "path", "required": true, "description": "Entity id of the alert to delete allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistDeletebyentityidEntityIdDeleteResponse" } } } } } } }, "/v2/integration/{integrationId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "integrationId", "in": "path", "required": true, "description": "ID of the integration to be deleted", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationIntegrationIdDeleteResponse" } } } } } }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "integrationId", "in": "path", "required": true, "description": "integration id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationIntegrationIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationIntegrationIdPutResponse" } } } } } } }, "/v2/notificationmutelist/deletebyalertid/{alertId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "alertId", "in": "path", "required": true, "description": "Alert id of the alert to delete allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationmutelistDeletebyalertidAlertIdDeleteResponse" } } } } } } }, "/v2/notificationmutelist/deletebyentityid/{entityId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "entityId", "in": "path", "required": true, "description": "Entity id of the alert to delete allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationmutelistDeletebyentityidEntityIdDeleteResponse" } } } } } } }, "/v2/notification/delete": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationDeletePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationDeletePostResponse" } } } } } } }, "/v2/aggregated-notification/enable-disable": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AggregatedNotificationEnableDisablePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AggregatedNotificationEnableDisablePostResponse" } } } } } } }, "/v2/notification/enabledisable": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationEnabledisablePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationEnabledisablePostResponse" } } } } } } }, "/v2/rule/enabledisable": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2RuleEnabledisablePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2RuleEnabledisablePostResponse" } } } } } } }, "/v2/integration/getall/{enterpriseId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "Enterprise id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationGetallEnterpriseIdGetResponse" } } } } } } }, "/v2/childalertlist": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ChildalertlistPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ChildalertlistPostResponse" } } } } } } }, "/v2/notificationlist": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationlistPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationlistPostResponse" } } } } } } }, "/v2/rulelist": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2RulelistPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2RulelistPostResponse" } } } } } } }, "/v2/parentalertlist": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ParentalertlistPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ParentalertlistPostResponse" } } } } } } }, "/v2/aggregated-notification/get-state": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AggregatedNotificationGetStateGetResponse" } } } } } } }, "/v2/allowlist/{ruleId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "ruleId", "in": "path", "required": true, "description": "Alert id of the alert to retrieve allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistRuleIdGetResponse" } } } } } } }, "/v2/allowlist-by-enterprise": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AllowlistByEnterpriseGetResponse" } } } } } } }, "/v2/notificationmutelist/{ruleId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "ruleId", "in": "path", "required": true, "description": "Alert id of the alert to retrieve allowlist/mutelist for", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationmutelistRuleIdGetResponse" } } } } } } }, "/v2/integration/test/{enterpriseId}/{integrationId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "Enterprise id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "integrationId", "in": "path", "required": true, "description": "Integration id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2IntegrationTestEnterpriseIdIntegrationIdGetResponse" } } } } } } }, "/v2/notification/update": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationUpdatePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2NotificationUpdatePostResponse" } } } } } } }, "/v2/assistant/add-to-conversation": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantAddToConversationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantAddToConversationPostResponse" } } } } } } }, "/v2/assistant/delete-conversation-chat/{conversationId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "conversationId", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantDeleteConversationChatConversationIdDeleteResponse" } } } } } } }, "/v2/assistant/conversation-interface-enable-disable/": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantConversationInterfaceEnableDisablePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantConversationInterfaceEnableDisablePostResponse" } } } } } } }, "/v2/assistant/conversation-context-history/": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantConversationContextHistoryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantConversationContextHistoryPostResponse" } } } } } } }, "/v2/assistant/version": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantVersionPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantVersionPostResponse" } } } } } } }, "/v2/assistant/conversation-interface-state/": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantConversationInterfaceStateGetResponse" } } } } } } }, "/v2/assistant/get-conversation-details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantGetConversationDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantGetConversationDetailsPostResponse" } } } } } } }, "/v2/assistant/get-conversations": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantGetConversationsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantGetConversationsPostResponse" } } } } } } }, "/v2/assistant/update-conversation-name": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantUpdateConversationNamePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssistantUpdateConversationNamePostResponse" } } } } } } }, "/v2/assurance/create-ai-adoption-approve-entry": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateAiAdoptionApproveEntryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateAiAdoptionApproveEntryPostResponse" } } } } } } }, "/v2/assurance/createclassifiedapplication": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateclassifiedapplicationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateclassifiedapplicationPostResponse" } } } } } } }, "/v2/assurance/create-dnsproxy-entry": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateDnsproxyEntryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateDnsproxyEntryPostResponse" } } } } } } }, "/v2/assurance/create-user-report": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateUserReportPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceCreateUserReportPostResponse" } } } } } } }, "/v2/assurance/delete-ai-adoption-approve-entry": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "idList", "in": "query", "description": "list of approved app entry identifiers to delete", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "example string" }, "example": [ "example" ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceDeleteAiAdoptionApproveEntryDeleteResponse" } } } } } } }, "/v2/assurance/deleteclassifiedapplication": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "classificationEntryIdList", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "example string" }, "example": [ "example" ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceDeleteclassifiedapplicationDeleteResponse" } } } } } } }, "/v2/assurance/delete-dnsproxy-entry": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceDeleteDnsproxyEntryDeleteResponse" } } } } } } }, "/v2/assurance/delete-user-report": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "reportId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceDeleteUserReportDeleteResponse" } } } } } } }, "/v2/assurance/download-user-report": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceDownloadUserReportGetResponse" } } } } } } }, "/v2/assurance/ai-adoption-summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceAiAdoptionSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceAiAdoptionSummaryPostResponse" } } } } } } }, "/v2/assurance/get-app-names": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceGetAppNamesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceGetAppNamesPostResponse" } } } } } } }, "/v2/assurance/applicationprofilesummary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceApplicationprofilesummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceApplicationprofilesummaryPostResponse" } } } } } } }, "/v2/assurance/applicationdetailsbyname": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceApplicationdetailsbynamePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceApplicationdetailsbynamePostResponse" } } } } } } }, "/v2/assurance/bucket-app-servers": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketAppServersPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketAppServersPostResponse" } } } } } } }, "/v2/assurance/bucket-apps": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketAppsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketAppsPostResponse" } } } } } } }, "/v2/assurance/bucketdetails": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketdetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketdetailsPostResponse" } } } } } } }, "/v2/assurance/bucket-services": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketServicesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketServicesPostResponse" } } } } } } }, "/v2/assurance/bucket-topologies": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketTopologiesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceBucketTopologiesPostResponse" } } } } } } }, "/v2/assurance/getclassifiedapplicationlist": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceGetclassifiedapplicationlistGetResponse" } } } } } } }, "/v2/assurance/enterprisesummary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceEnterprisesummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceEnterprisesummaryPostResponse" } } } } } } }, "/v2/assurance/scoredetails": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceScoredetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceScoredetailsPostResponse" } } } } } } }, "/v2/assurance/topology-client-session-details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSessionDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSessionDetailsPostResponse" } } } } } } }, "/v2/assurance/topology-client-sessions": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSessionsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSessionsPostResponse" } } } } } } }, "/v2/assurance/topology-client-summaries": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSummariesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyClientSummariesPostResponse" } } } } } } }, "/v2/assurance/topology-inventory": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyInventoryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyInventoryPostResponse" } } } } } } }, "/v2/assurance/topology-overview": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyOverviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyOverviewPostResponse" } } } } } } }, "/v2/assurance/topology-region-summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyRegionSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologyRegionSummaryPostResponse" } } } } } } }, "/v2/assurance/topology-site-summaries": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologySiteSummariesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceTopologySiteSummariesPostResponse" } } } } } } }, "/v2/assurance/unclassifiedapplicationprofilesummary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUnclassifiedapplicationprofilesummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUnclassifiedapplicationprofilesummaryPostResponse" } } } } } } }, "/v2/assurance/read-ai-adoption-approve-entries": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceReadAiAdoptionApproveEntriesGetResponse" } } } } } } }, "/v2/assurance/read-dnsproxy-list": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceReadDnsproxyListGetResponse" } } } } } } }, "/v2/assurance/read-user-report-list": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceReadUserReportListGetResponse" } } } } } } }, "/v2/assurance/update-ai-adoption-approve-entry": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateAiAdoptionApproveEntryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateAiAdoptionApproveEntryPostResponse" } } } } } } }, "/v2/assurance/updateclassifiedapplication": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateclassifiedapplicationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateclassifiedapplicationPostResponse" } } } } } } }, "/v2/assurance/update-dnsproxy-entry": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateDnsproxyEntryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AssuranceUpdateDnsproxyEntryPostResponse" } } } } } } }, "/v1/activity/logs": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ActivityLogsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ActivityLogsPostResponse" } } } } } } }, "/v1/audit/logs": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuditLogsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuditLogsPostResponse" } } } } } } }, "/v2/audit/logs": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AuditLogsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2AuditLogsPostResponse" } } } } } } }, "/v1/ztagent/agents": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "createdDateEnd", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "createdDateStart", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "endpoints", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "example string" }, "example": [ "example" ] }, "style": "form", "explode": true }, { "name": "hostname", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "limit", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "machineId", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "page", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "tenantId", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "updatedDateEnd", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "updatedDateStart", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ZtagentAgentsGetResponse" } } } } }, "description": "List Conceal agents (devices) with pagination and filters." } }, "/v1/ztagent/bindings": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ZtagentBindingsGetResponse" } } } } }, "description": "Return the ZTAgent integration binding for an enterprise." }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ZtagentBindingsPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ZtagentBindingsPutResponse" } } } } }, "description": "Create or replace the ZTAgent integration binding for an enterprise (site and customer identifiers)." } }, "/v1/devices/{deviceId}/jobs/{jobId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "jobId", "in": "path", "required": true, "description": "id of the job as received from the Enqueue* calls.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1234 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdJobsJobIdGetResponse" } } } } }, "description": "Get device job status" } }, "/v1/diagnostic/clear-arp/{deviceId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Unique identifier for a specific device", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticClearArpDeviceIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Clear arp entries" } }, "/v1/diagnostic/archive-create/{deviceId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Valid Provisioned device ID", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticArchiveCreateDeviceIdPostRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticArchiveCreateDeviceIdPostResponse" } } } } }, "description": "Create a device debug archive" } }, "/v1/diagnostic/archive-delete/{archiveId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "archiveId", "in": "path", "required": true, "description": "Unique identifier for a specific archive", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a device debug archive" } }, "/v1/diagnostic/archive-edit/{archiveId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "archiveId", "in": "path", "required": true, "description": "Unique identifier for a specific archive", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticArchiveEditArchiveIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Edit metadata for a previously generated device debug archive" } }, "/v1/diagnostic/gnmi-ping": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "example": 30000022569 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticGnmiPingGetResponse" } } } } }, "description": "perform GNMI ping test" } }, "/v1/diagnostic/archives/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Valid Provisioned device ID", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticArchivesDeviceIdGetResponse" } } } } }, "description": "Get a list of device debug archive collections" } }, "/v1/diagnostic/otp/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Unique identifier for a specific device", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticOtpDeviceIdGetResponse" } } } } }, "description": "Get a one-time passcode to access a device" } }, "/v1/diagnostic/packetcapture/{pcapId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "pcapId", "in": "path", "required": true, "description": "Unique identifier for a specific packet capture", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPacketcapturePcapIdGetResponse" } } } } }, "description": "get a packet capture" } }, "/v1/diagnostic/speedtest-providers": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestProvidersGetResponse" } } } } }, "description": "Get list of supported speedtest service providers" } }, "/v1/diagnostic/speedtest-servers": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Unique identifier for a specific device", "required": true, "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "example": 30000000555 }, { "name": "provider", "in": "query", "description": "supported provider for speedtest utility", "required": true, "schema": { "type": "string", "example": "ENUM_VALUE" }, "example": "ookla" }, { "name": "vrfName", "in": "query", "description": "Configured Wan Circuit Name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "c-gigabitethernet1" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestServersGetResponse" } } } } }, "description": "Get list of servers for a provider" } }, "/v1/diagnostic/packetcapture-start": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPacketcaptureStartPostRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPacketcaptureStartPostResponse" } } } } }, "description": "Start packet capture" } }, "/v1/diagnostic/packetcapture-stop": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPacketcaptureStopPostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Stop packet capture" } }, "/v1/diagnostic/reboot/{deviceId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Valid Provisioned device ID", "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticRebootDeviceIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Trigger a device reboot" } }, "/v1/diagnostic/bgp-reset/{deviceId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Unique identifier for a specific device", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticBgpResetDeviceIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Reset a BGP neighbor" } }, "/v1/diagnostic/reset-ipsec-session/{deviceId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Unique identifier for a specific device", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticResetIpsecSessionDeviceIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Reset IPSec sessions" } }, "/v1/diagnostic/interface-reset/{deviceId}": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "Unique identifier for a specific device", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticInterfaceResetDeviceIdPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Reset an interface" } }, "/v1/diagnostic/speedtest-report": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestReportPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestReportPutResponse" } } } } }, "description": "Generate a speedtest history report" } }, "/v1/diagnostic/ping": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPingPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPingPostResponse" } } } } }, "description": "Trigger a diagnostic test" } }, "/v1/diagnostic/traceroute": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticTraceroutePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticTraceroutePostResponse" } } } } }, "description": "Trigger a diagnostic test" } }, "/v1/diagnostic/speedtest": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticSpeedtestPostResponse" } } } } }, "description": "Trigger Speedtest utility" } }, "/v1/diagnostic/ping-stop/{token}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "token", "in": "path", "required": true, "description": "Identifier which was received in initial response", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DiagnosticPingStopTokenPostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Stop ping session" } }, "/v1/users/{email}/password": { "patch": { "description": "Change password for a user using email and token", "parameters": [ { "in": "path", "name": "email", "required": true, "schema": { "type": "string", "example": "user@example.com" }, "description": "User email address" }, { "in": "query", "name": "token", "required": true, "schema": { "type": "string", "example": "verification-token-12345" }, "description": "Password reset token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersEmailPasswordPatchRequest" } } } }, "responses": { "204": { "description": "Password changed successfully" }, "400": { "description": "Bad request - Invalid input" }, "403": { "description": "Forbidden - Invalid token" }, "500": { "description": "Internal server error" } } } }, "/v1/users/{email}/recovery": { "get": { "description": "Send password recovery email to user", "parameters": [ { "in": "path", "name": "email", "required": true, "schema": { "type": "string", "example": "user@example.com" }, "description": "User email address" } ], "responses": { "200": { "description": "Recovery email sent successfully" }, "400": { "description": "Bad request - Invalid email" }, "500": { "description": "Internal server error" } } } }, "/v1/users/{email}/verified": { "patch": { "description": "Verify user email using verification token", "parameters": [ { "in": "path", "name": "email", "required": true, "schema": { "type": "string", "example": "user@example.com" }, "description": "User email address" }, { "in": "query", "name": "token", "required": true, "schema": { "type": "string", "example": "verification-token-12345" }, "description": "Email verification token" } ], "responses": { "204": { "description": "User email verified successfully" }, "400": { "description": "Bad request - Invalid input" }, "403": { "description": "Forbidden - Invalid token" }, "500": { "description": "Internal server error" } } } }, "/v1/enterprises/eula": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesEulaPostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Accept End User License Agreement for the enterprise." } }, "/v1/groups/{id}/enterprises": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsIdEnterprisesPostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Associate group with additional enterprises to enable cross-enterprise access and management." } }, "/v1/groups/{id}/members": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsIdMembersPostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Add multiple users to a group by their global IDs." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsIdMembersGetResponse" } } } } }, "description": "Get all members of a specific group." } }, "/v1/account/mfa/confirmation": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountMfaConfirmationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountMfaConfirmationPostResponse" } } } } }, "description": "Confirm MFA type change with verification code." } }, "/v1/enterprises": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Create a new enterprise with company details, account type, and admin user. MSP callers creating a managed enterprise supply pool credit allocation fields (allocated_credits and optional term end)." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseIds", "in": "query", "description": "Lists enterprises", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": [ 0 ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesGetResponse" } } } } }, "description": "Get specific enterprises by their IDs with detailed information. Query just your own enterprise Id for more detailed info." }, "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Updates all relevent enterprise information." } }, "/v1/groups": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Create a new group with and set permissions. Set group's enterprise management capabilities (msp only)." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsGetResponse" } } } } }, "description": "Get all groups in the enterprise." } }, "/v1/auth": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Configure Identity Provider (SAML) for enterprise. Creates IDP configuration affecting all users in the enterprise." }, "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove Identity Provider configuration and revert to default authentication." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthGetResponse" } } } } }, "description": "Get current Identity Provider configuration for enterprise." }, "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Update Identity Provider configuration (certificates, endpoints, etc.)." } }, "/v1/users": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Create a new user account with profile information. Assigns to specified group or default read-only group. Handles both IDP and non-IDP configured enterprises." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersGetResponse" } } } } }, "description": "Get user information by user IDs with detailed profile data." } }, "/v1/groups/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a group and remove all member associations and enterprise relationships. Replace with a different group if specified." }, "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsIdPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Update group information." } }, "/v1/groups/{id}/enterprises/{enterpriseId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove group's association with a specific enterprise, revoking cross-enterprise access." } }, "/v1/groups/{id}/members/{memberId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } }, { "name": "memberId", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove a specific user from a group by member ID." } }, "/v1/groups/{id}/members/delete": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsIdMembersDeletePostRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Remove multiple users from a group by their member IDs." } }, "/v1/enterprises/{enterpriseId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a specific enterprise by ID (you must manage this tenant)." } }, "/v1/users/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete user account." } }, "/v1/account/mfa": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove user's MFA enrollment." }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountMfaGetResponse" } } } } }, "description": "Get user's current MFA type and enrollment status." }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountMfaPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountMfaPutResponse" } } } } }, "description": "Update user's MFA type (SMS, GoogleAuth) with verification." } }, "/v1/auth/mfa": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthMfaPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Enroll tenant in Multi-Factor Authentication (SMS, GoogleAuth)." }, "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "204": { "description": "No Content" } }, "description": "Remove Multi-Factor Authentication enrollment for the tenant." }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthMfaPostRequest" } } } }, "responses": { "200": { "description": "MFA verification successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPostResponse" } } } }, "400": { "description": "Bad request - Missing required fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthErrorPostResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Internal error" } } } } } } } } }, "/v1/users/passwords/expire": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersPasswordsExpirePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersPasswordsExpirePostResponse" } } } } }, "description": "Expire passwords for multiple users and send password reset emails (Graphiant cloud only)." } }, "/v1/groups/enterprises": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsEnterprisesGetResponse" } } } } }, "description": "Get all enterprise-level groups." } }, "/v1/groups/root": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GroupsRootGetResponse" } } } } }, "description": "Get all root-level groups." } }, "/v1/enterprises/{enterpriseId}/admin": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesEnterpriseIdAdminGetResponse" } } } } }, "description": "Get the admin account for an enterprise." } }, "/v1/auth/mfa/types": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthMfaTypesGetResponse" } } } } }, "description": "Get MFA types allowed by enterprise policy." }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthMfaTypesPutRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Update enterprise MFA policy to allow/disallow specific MFA types." } }, "/v1/enterprises/managed": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "type", "in": "query", "description": "msp or enterprise", "required": true, "schema": { "type": "string", "example": "ENUM_VALUE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesManagedGetResponse" } } } } }, "description": "Get enterprises managed by your tenant, filtered by enterprise type. For MSP-managed enterprises, responses include MSP pool fields such as allocated_credits and credit_allocation_contract_expiration when applicable." } }, "/v1/users/{id}/groups/enterprises": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "userId", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersIdGroupsEnterprisesGetResponse" } } } } }, "description": "Get enterprise-specific groups for a user." } }, "/v1/users/{id}/enterprises": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "userId", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersIdEnterprisesGetResponse" } } } } }, "description": "Get all enterprises a specific user can access." } }, "/v1/users/{id}/groups": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "userId", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersIdGroupsGetResponse" } } } } }, "description": "Get all groups that a specific user belongs to." } }, "/v1/users/{id}/groups/root": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "userId", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersIdGroupsRootGetResponse" } } } } }, "description": "Get root-level groups for a user." } }, "/v1/users/{id}/verify": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1UsersIdVerifyPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Resend account verification email to user." } }, "/v1/invitation/email": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1InvitationEmailPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1InvitationEmailPostResponse" } } } } }, "description": "Send invitation emails for B2B data exchange service connections. For non-Graphiant enterprises, sends invite to all admin users in the proxy tenant desiganted by your msp. For Graphiant, sends to specified admin email." } }, "/v1/temp/password": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TempPasswordPutRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TempPasswordPutResponse" } } } } }, "description": "Generate and send temporary passwords to multiple emails for B2B service access." } }, "/v1/account/email": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountEmailPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Update user's email address with verification." } }, "/v1/account/info": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountInfoPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Update current user's profile information." } }, "/v1/account/password": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AccountPasswordPatchRequest" } } } }, "responses": { "204": { "description": "No Content" } }, "description": "Change user password with current password verification (Graphiant cloud only)." } }, "/v1/apps/bandwidth": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsBandwidthPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsBandwidthPostResponse" } } } } } } }, "/v1/flows/flow-table": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1FlowsFlowTablePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1FlowsFlowTablePostResponse" } } } } }, "description": "Get flow table for the app on the device" } }, "/v1/apps/app-summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsAppSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsAppSummaryPostResponse" } } } } }, "description": "Get app state summary counts" } }, "/v1/apps/visualization": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsVisualizationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsVisualizationPostResponse" } } } } }, "description": "Get the app and circuit visualization info for the device" } }, "/v1/extranet-b2b-monitoring/peering-service/consumption-overview": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceConsumptionOverviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceConsumptionOverviewPostResponse" } } } } }, "description": "Get b2b extranet peering consumption overview" } }, "/v1/extranet-b2b-monitoring/peering-service/bandwidth-usage": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceBandwidthUsagePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceBandwidthUsagePostResponse" } } } } }, "description": "Get b2b extranet peering service sites usage stats" } }, "/v1/extranet-b2b-monitoring/peering-service/service-overtime-consumption": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceOvertimeConsumptionPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceOvertimeConsumptionPostResponse" } } } } }, "description": "Get b2b extranet peering service overtime consumption" } }, "/v1/extranet-b2b-monitoring/peering-service/consumers-usage/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceConsumersUsageTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceConsumersUsageTopPostResponse" } } } } }, "description": "Get b2b extranet peering service top consumers usage stats" } }, "/v1/extranet-b2b-monitoring/peering-service/service-customer-list": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceCustomerListPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceCustomerListPostResponse" } } } } }, "description": "Get b2b extranet peering service customer list within a time window" } }, "/v2/extranet/sites-consumption-overview": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetSitesConsumptionOverviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetSitesConsumptionOverviewPostResponse" } } } } }, "description": "Get extranet service consumption overview over timewindow" } }, "/v2/extranet/service-overtime-consumption": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetServiceOvertimeConsumptionPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetServiceOvertimeConsumptionPostResponse" } } } } }, "description": "Get extranet service cumulative consumption over timewindow" } }, "/v2/extranet/sites-usage": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetSitesUsagePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetSitesUsagePostResponse" } } } } }, "description": "Get extranet service sites usage stats v2" } }, "/v2/extranet/consumers-usage/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetConsumersUsageTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetConsumersUsageTopPostResponse" } } } } }, "description": "Get extranet service top consumer usage stats" } }, "/v2/extranet/lan-segments-usage/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetLanSegmentsUsageTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetLanSegmentsUsageTopPostResponse" } } } } }, "description": "Get extranet service top lan segment usage stats" } }, "/v1/extranet/sites-usage/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetSitesUsageTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetSitesUsageTopPostResponse" } } } } }, "description": "Get extranet service top sites usage stats" } }, "/v2/extranet/total-usage": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetTotalUsagePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetTotalUsagePostResponse" } } } } }, "description": "Get extranet service total usage stats" } }, "/v1/nat/entries/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1NatEntriesDeviceIdGetResponse" } } } } }, "description": "Get the NAT entries for the device" } }, "/v1/nat/utilization/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1NatUtilizationDeviceIdGetResponse" } } } } }, "description": "Get the NAT usage for the device" } }, "/v1/flows/topology": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1FlowsTopologyPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1FlowsTopologyPostResponse" } } } } }, "description": "Get flow based node and circuit topology for the device" } }, "/v1/apps/device/{deviceId}/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsDeviceDeviceIdTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsDeviceDeviceIdTopPostResponse" } } } } }, "description": "Get top apps for a device" } }, "/v1/apps/site/{siteId}/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsSiteSiteIdTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AppsSiteSiteIdTopPostResponse" } } } } }, "description": "Get top apps for a site" } }, "/v1/talkers/device/{deviceId}/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TalkersDeviceDeviceIdTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TalkersDeviceDeviceIdTopPostResponse" } } } } }, "description": "Get top talkers for a device" } }, "/v1/talkers/site/{siteId}/top": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TalkersSiteSiteIdTopPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TalkersSiteSiteIdTopPostResponse" } } } } }, "description": "Get top talkers for a site" } }, "/v1/extranets/{id}/apply": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdApplyPostRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdApplyPostResponse" } } } } } } }, "/v1/extranet/b2b/matches/{matchId}/consumer/check": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "Match id (URL path :matchId)", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdConsumerCheckPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdConsumerCheckPostResponse" } } } } }, "description": "Check extranet service consumer configuration" } }, "/v1/global/config": { "patch": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalConfigPatchRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalConfigPatchResponse" } } } } }, "description": "Update global objects for an enterprise" } }, "/v1/global/apps/app-lists": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsPostResponse" } } } } }, "description": "Create an app list under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsGetResponse" } } } } }, "description": "Get all app lists for the current enterprise" } }, "/v1/data-assurance/assurances/global": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalPostResponse" } } } } }, "description": "Configure a new assurance under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalGetResponse" } } } } }, "description": "Get all assurances under the current enterprise" } }, "/v1/extranets-b2b/{id}/customer/": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Service ID of the application customer is invited to", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdCustomerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdCustomerPostResponse" } } } } }, "description": "Create B2B extranet application customer invite" } }, "/v1/extranets-b2b/consumer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerPostResponse" } } } } }, "description": "Create a new B2B extranet consumer" } }, "/v1/extranets-b2b-peering/match/service-to-customer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerPostResponse" } } } } }, "description": "Create B2B extranet configuration for matching a service to a customer" } }, "/v1/extranets-b2b-peering/consumer/{matchId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "ID of the match for the customer subscription of the service", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerMatchIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerMatchIdPostResponse" } } } } }, "description": "Create B2B extranet peering service consumer" } }, "/v1/extranets-b2b-peering/customer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringCustomerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringCustomerPostResponse" } } } } }, "description": "Create a new B2B extranet peering service customer" } }, "/v1/extranets-b2b-peering/producer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringProducerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringProducerPostResponse" } } } } }, "description": "Create a new B2B extranet peering service producer" } }, "/v1/extranets-b2b": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPostResponse" } } } } }, "description": "Create a new B2B extranet producer" } }, "/v1/device/snapshot": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotPostRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotPostResponse" } } } } }, "description": "Create a device snapshot" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotGetResponse" } } } } }, "description": "Get the specified device snapshots using the snapshot id" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotPutResponse" } } } } }, "description": "Update an existing device snapshot" } }, "/v1/extranets": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsPostResponse" } } } } } }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsGetResponse" } } } } } } }, "/v1/extranet/b2b/producer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerPostResponse" } } } } }, "description": "Create an inter-enterprise extranet service (peering, client-to-server, …)" } }, "/v1/extranet/b2b/matches/{matchId}/consumer": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "Match id (URL path :matchId)", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdConsumerPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdConsumerPostResponse" } } } } }, "description": "Consumer accepts an extranet service match" } }, "/v1/extranet/b2b/customers": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersPostResponse" } } } } }, "description": "Create an extranet service customer (partner directory entry)" } }, "/v1/extranet/b2b/matches": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesPostResponse" } } } } }, "description": "Match an extranet service to a customer" } }, "/v1/extranet/b2b/matches/customers": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesCustomersPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesCustomersPostResponse" } } } } }, "description": "Bulk subscribe customers to an extranet service" } }, "/v1/gateways": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysPostResponse" } } } } } }, "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysDeleteResponse" } } } } } }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysPutResponse" } } } } } } }, "/v1/global/apps/custom": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomPostResponse" } } } } }, "description": "Create a new global app under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomGetResponse" } } } } }, "description": "Get all global apps mapped by the current enterprise" } }, "/v1/global/content-filters": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersPostResponse" } } } } }, "description": "Configure a new content filter under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersGetResponse" } } } } }, "description": "Get basic details for all content filter under the current enterprise" } }, "/v1/global/lan-segments": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalLanSegmentsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalLanSegmentsPostResponse" } } } } }, "description": "Create a new lan-segment scoped to the enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "filterExtranetProducers", "in": "query", "description": "", "required": false, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalLanSegmentsGetResponse" } } } } }, "description": "Get a list of lan-segments under the currently logged in enterprise" } }, "/v1/pvif": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifPostResponse" } } } } }, "description": "Create a gateway Public VIF service" } }, "/v1/policy/route-tag-sets": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsPostResponse" } } } } }, "description": "Create a new route tag scoped to the enterprise" } }, "/v1/sites": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesPostResponse" } } } } }, "description": "Create an enterprise site" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesGetResponse" } } } } }, "description": "Get sites for the current enterprise" } }, "/v1/global/site-lists": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsPostResponse" } } } } }, "description": "Create a new site list scoped to the enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsGetResponse" } } } } }, "description": "Get a list of site lists under the currently logged in enterprise" } }, "/v1/global/apps/app-lists/{appListId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appListId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsAppListIdDeleteResponse" } } } } }, "description": "Delete an app list under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appListId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsAppListIdGetResponse" } } } } }, "description": "Get the configuration for an app list under the current enterprise" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appListId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsAppListIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsAppListIdPutResponse" } } } } }, "description": "Overwrite the configuration for an app list under the current enterprise" } }, "/v1/data-assurance/assurances/global/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalIdDeleteResponse" } } } } }, "description": "Delete an assurance under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalIdGetResponse" } } } } }, "description": "Get the config for an assurance under the current enterprise" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesGlobalIdPutResponse" } } } } }, "description": "Overwrite a pre-existing assurance under the current enterprise" } }, "/v1/extranets-b2b/consumer/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerIdDeleteResponse" } } } } }, "description": "Delete a B2B extranet consumer" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerIdGetResponse" } } } } }, "description": "Get a B2B extranet consumer" } }, "/v1/extranets-b2b/customer/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bCustomerIdDeleteResponse" } } } } }, "description": "Delete a B2B extranet customer" } }, "/v1/extranets-b2b-peering/match/service-to-customer/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID for the service to customer match to be deleted", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerIdDeleteResponse" } } } } }, "description": "Unsubscribe a customer from a service" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Service id for which match details are requested", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "customerId", "in": "query", "description": "Customer id", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerIdGetResponse" } } } } }, "description": "Get details for a service to customer subscription" } }, "/v1/extranets-b2b-peering/customer/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the peering service customer", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringCustomerIdDeleteResponse" } } } } }, "description": "Delete a B2B extranet peering service customer" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the peering service customer", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringCustomerIdGetResponse" } } } } }, "description": "Get a B2B extranet peering service customer" } }, "/v1/extranets-b2b/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the producer service to be deleted", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdDeleteResponse" } } } } }, "description": "Delete a B2B extranet producer" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the B2B Application service", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdPutResponse" } } } } }, "description": "Update a B2B extranet producer" } }, "/v1/device/snapshot/{snapshotId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "snapshotId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete specified device snapshot" } }, "/v1/devices/{deviceId}/draft": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete draft configuration" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdDraftGetResponse" } } } } }, "description": "Get draft configuration" }, "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdDraftPostRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdDraftPostResponse" } } } } }, "description": "Save draft configuration" } }, "/v1/extranets/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdDeleteResponse" } } } } } }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdGetResponse" } } } } } }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdPutResponse" } } } } } } }, "/v1/extranet/b2b/producer/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdDeleteResponse" } } } } }, "description": "Delete an inter-enterprise extranet service" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdGetResponse" } } } } }, "description": "Get an inter-enterprise extranet service" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdPutResponse" } } } } }, "description": "Update an inter-enterprise extranet service" } }, "/v1/extranet/b2b/consumers/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdDeleteResponse" } } } } }, "description": "Delete an extranet service consumer subscription" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Consumer subscription id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdPutResponse" } } } } }, "description": "Update extranet service consumer" } }, "/v1/extranet/b2b/customers/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdDeleteResponse" } } } } }, "description": "Delete an extranet service customer" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdPutResponse" } } } } }, "description": "Update an extranet service customer" } }, "/v1/extranet/b2b/matches/{matchId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "Match id (URL path :matchId)", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdDeleteResponse" } } } } }, "description": "Delete an extranet service match" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "Match id (URL path :matchId)", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdGetResponse" } } } } }, "description": "Get extranet service match details" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "Match id (URL path :matchId)", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdPutResponse" } } } } }, "description": "Update extranet service match" } }, "/v1/global/apps/custom/{appId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomAppIdDeleteResponse" } } } } }, "description": "Delete a global app under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomAppIdGetResponse" } } } } }, "description": "Get the configuration for a global app under the current enterprise" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomAppIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomAppIdPutResponse" } } } } }, "description": "Overwrite the configuration for a global app under the current enterprise" } }, "/v1/global/content-filters/{globalContentFilterId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "globalContentFilterId", "in": "path", "required": true, "description": "ID of the global content filter to remove.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersGlobalContentFilterIdDeleteResponse" } } } } }, "description": "Delete a content filter under the current enterprise" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "globalContentFilterId", "in": "path", "required": true, "description": "ID of the global content filter whose configuration should be returned.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersGlobalContentFilterIdGetResponse" } } } } }, "description": "Get the config for a content filter under the current enterprise" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "globalContentFilterId", "in": "path", "required": true, "description": "ID of the global content filter to replace with the supplied configuration.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersGlobalContentFilterIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalContentFiltersGlobalContentFilterIdPutResponse" } } } } }, "description": "Overwrite a pre-existing content filter under the current enterprise" } }, "/v1/global/lan-segments/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a lan-segment" } }, "/v1/pvif/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Producer service id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifIdDeleteResponse" } } } } }, "description": "Delete a gateway Public VIF service" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Producer service id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifIdPutResponse" } } } } }, "description": "Update a gateway Public VIF service" } }, "/v1/policy/route-tag-sets/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "level", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsIdDeleteResponse" } } } } }, "description": "Create a new route-tag scoped to the enterprise" } }, "/v1/sites/{siteId}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a site" }, "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesSiteIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesSiteIdPostResponse" } } } } }, "description": "Update a site" } }, "/v1/global/site-lists/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete a site list" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsIdGetResponse" } } } } }, "description": "Get a details of a site list" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsIdPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsIdPutResponse" } } } } }, "description": "Update a new site list scoped to the enterprise" } }, "/v1/extranets/source-segments": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsSourceSegmentsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsSourceSegmentsPostResponse" } } } } } } }, "/v1/enterprise/snapshot": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseSnapshotGetResponse" } } } } }, "description": "Get a all of the device snapshots for every device in an enterprise" } }, "/v1/enterprise/allocation": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseAllocationGetResponse" } } } } }, "description": "Get all allocation for the given enterprise on a given month" } }, "/v1/global/apps/categories": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCategoriesGetResponse" } } } } }, "description": "Get all app categories holding Graphiant apps" } }, "/v1/global/apps/custom/{appId}/details/app-lists": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCustomAppIdDetailsAppListsGetResponse" } } } } }, "description": "Get all app lists that contain the relevant global app" } }, "/v1/global/apps/app-list-options": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListOptionsGetResponse" } } } } }, "description": "Gets all apps and categories assignable to an app list for the the current enterprise" } }, "/v1/global/apps/categories/{categoryId}/apps": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "categoryId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsCategoriesCategoryIdAppsGetResponse" } } } } }, "description": "Get all Graphiant apps in an app category" } }, "/v1/global/apps/app-lists/{appListId}/details/apps": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "appListId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsAppListsAppListIdDetailsAppsGetResponse" } } } } }, "description": "Get all apps that are members of the provided app list" } }, "/v1/data-assurance/assurances/applications/{bucketAppName}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "bucketAppName", "in": "path", "required": true, "description": "", "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceAssurancesApplicationsBucketAppNameGetResponse" } } } } }, "description": "Gets the assurance details for all edges under the current enterprise" } }, "/v1/global/attached-edges": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAttachedEdgesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAttachedEdgesPostResponse" } } } } }, "description": "Returns attached edges for global object" } }, "/v1/extranets-b2b/customer-info/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bCustomerInfoIdGetResponse" } } } } }, "description": "Get B2B extranet application customer" } }, "/v1/extranets-b2b/{id}/customer-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdCustomerSummaryGetResponse" } } } } }, "description": "Get B2B extranet application customers summary" } }, "/v1/extranets-b2b/consumer-device-status/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerDeviceStatusIdGetResponse" } } } } }, "description": "Get B2B extranet consumer status" } }, "/v1/extranets-b2b/consumer-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bConsumerSummaryGetResponse" } } } } }, "description": "Get B2B extranet consumers summary" } }, "/v1/extranets-b2b-general/customers-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bGeneralCustomersSummaryGetResponse" } } } } }, "description": "Get summary for a B2B extranet peering services customers" } }, "/v1/extranets-b2b-peering/producer/{id}/matching-customers-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the customer", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringProducerIdMatchingCustomersSummaryGetResponse" } } } } }, "description": "Get B2B extranet customers summary" } }, "/v1/extranets-b2b-peering/match/services/summary/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the customer", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServicesSummaryIdGetResponse" } } } } }, "description": "Get B2B extranet services matching customers summary" } }, "/v1/extranets-b2b-peering/consumer/{customerId}/consumer-details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "customerId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "serviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerCustomerIdConsumerDetailsGetResponse" } } } } }, "description": "Get details of a service subscription for a customer" } }, "/v1/extranets-b2b-peering/producer/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "ID of the service", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringProducerIdGetResponse" } } } } }, "description": "Get B2B extranet peering service producer" } }, "/v1/extranets-b2b/{id}/producer": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "type", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "ENUM_VALUE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bIdProducerGetResponse" } } } } }, "description": "Get a B2B extranet producer" } }, "/v1/extranets-b2b/producer-device-status/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bProducerDeviceStatusIdGetResponse" } } } } }, "description": "Get B2B extranet producer status" } }, "/v1/extranets-b2b/producers-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bProducersSummaryGetResponse" } } } } }, "description": "Get B2B extranet producers summary" } }, "/v1/extranets-b2b-peering/consumer/{matchId}/match-details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerMatchIdMatchDetailsGetResponse" } } } } }, "description": "Get details of a service match for a customer" } }, "/v1/extranets-b2b-general/services-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bGeneralServicesSummaryGetResponse" } } } } }, "description": "Get a summary for all the B2B extranet services" } }, "/v1/devices/session-status": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesSessionStatusPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesSessionStatusPostResponse" } } } } }, "description": "Get all the BGP session states for the devices" } }, "/v1/devices/{deviceId}/candidate-circuits": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdCandidateCircuitsGetResponse" } } } } }, "description": "Get the candidate circuits for a device" } }, "/v1/qos/circuit-profiles": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1QosCircuitProfilesGetResponse" } } } } }, "description": "Returns a list of QoS profiles for circuits with associated queues & attributes" } }, "/v1/sites/{siteId}/circuits": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesSiteIdCircuitsGetResponse" } } } } }, "description": "Get Circuits for the site" } }, "/v1/devices/{deviceId}/vrf/protocols": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "vrfName", "in": "query", "description": "Valid Configured Vrf Name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "lan-1-business" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdVrfProtocolsGetResponse" } } } } } } }, "/v1/devices/{deviceId}/connectivity": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdConnectivityGetResponse" } } } } }, "description": "Get the connectivity graph for a device" } }, "/v1/devices/{deviceId}/twamp/core": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdTwampCoreGetResponse" } } } } }, "description": "Get core TWAMP neighbors for a given device" } }, "/v1/devices/{deviceId}/dhcp-server/leases": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdDhcpServerLeasesGetResponse" } } } } }, "description": "Get current DHCP leases for a device" } }, "/v1/policy/applications": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyApplicationsGetResponse" } } } } }, "description": "Get a list of builtin DPI applications" } }, "/v1/devices/{deviceId}/policy/applications": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdPolicyApplicationsGetResponse" } } } } }, "description": "Get a list of builtin DPI applications able to be configured on a given device based on GNOS version" } }, "/v1/devices/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdGetResponse" } } } } }, "description": "Get a specific device" } }, "/v1/devices/{deviceId}/versions/{version}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "16 bytes (base64 encoded) identifier for the device.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 3000000000 }, { "name": "version", "in": "path", "required": true, "description": "8 bytes (base32 encoded) version number.", "schema": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "example": 150 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdVersionsVersionGetResponse" } } } } }, "description": "Get device config for a specific version" } }, "/v1/devices/{deviceId}/versions": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "16 bytes (base64 encoded) identifier for the device.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 3000000000 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdVersionsGetResponse" } } } } }, "description": "Get device config versions" } }, "/v1/device/snapshot/{deviceId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceSnapshotDeviceIdGetResponse" } } } } }, "description": "Get all of a device's snapshots" } }, "/v1/devices": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesGetResponse" } } } } }, "description": "Get devices for the current enterprise" } }, "/v1/sites/{siteId}/devices": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesSiteIdDevicesGetResponse" } } } } }, "description": "Get Devices for the site" } }, "/v1/devices-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesSummaryGetResponse" } } } } }, "description": "Get devices summary for the specified enterprise" } }, "/v1/global/domain-categories": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalDomainCategoriesGetResponse" } } } } }, "description": "Get all domain categories from the DPI engine" } }, "/v1/enterprise/configuration": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseConfigurationGetResponse" } } } } }, "description": "Get enterprise-level information relevant to device configuration" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseConfigurationPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseConfigurationPutResponse" } } } } }, "description": "Update enterprise-level information relevant to device configuration" } }, "/v1/extranets/{id}/status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsIdStatusGetResponse" } } } } } } }, "/v1/extranet/b2b/consumers/{customerId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "customerId", "in": "path", "required": true, "description": "Partner customer id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "serviceId", "in": "query", "description": "Producer service id", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersCustomerIdGetResponse" } } } } }, "description": "Get extranet service consumer subscription" } }, "/v1/extranet/b2b/consumers/{id}/device-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdDeviceStatusGetResponse" } } } } }, "description": "Get extranet consumer device rollout status" } }, "/v2/extranets-monitoring/consumers": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetsMonitoringConsumersPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2ExtranetsMonitoringConsumersPostResponse" } } } } }, "description": "Get consumer list for b2b producer service" } }, "/v1/extranet/b2b/customers/{id}/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdDetailsGetResponse" } } } } }, "description": "Get an extranet service customer" } }, "/v1/extranet/b2b/customers/{id}/matches/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Customer id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdMatchesSummaryGetResponse" } } } } }, "description": "Get matched services summary for a customer" } }, "/v1/extranet/b2b/customers/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersSummaryGetResponse" } } } } }, "description": "List extranet service customers for the enterprise" } }, "/v1/extranets-monitoring/lan-segments": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "Extranet Service Id", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 800 }, { "name": "isProvider", "in": "query", "description": "", "required": false, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsMonitoringLanSegmentsGetResponse" } } } } } } }, "/v1/extranet/b2b/matches/{matchId}/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdDetailsGetResponse" } } } } }, "description": "Get match details for consumer accept flow" } }, "/v1/extranets-monitoring/nat-usage": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "Extranet Service Id", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 800 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsMonitoringNatUsageGetResponse" } } } } } } }, "/v1/extranet/b2b/producer/{id}/customers": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Producer service id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdCustomersGetResponse" } } } } }, "description": "List customers matched to an extranet producer service" } }, "/v1/extranet/b2b/producer/{id}/device-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdDeviceStatusGetResponse" } } } } }, "description": "Get extranet producer device rollout status" } }, "/v1/extranets-monitoring/traffic-security-policy": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsMonitoringTrafficSecurityPolicyPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsMonitoringTrafficSecurityPolicyPostResponse" } } } } }, "description": "Get lists of traffic and security policies" } }, "/v1/extranet/b2b/services/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bServicesSummaryGetResponse" } } } } }, "description": "List inter-enterprise extranet services" } }, "/v1/devices/{deviceId}/policy/zonepairs": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdPolicyZonepairsGetResponse" } } } } }, "description": "Get a list of firewall zone pairs each with holding nested policy rule sets" } }, "/v1/data-assurance/flex-algos": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DataAssuranceFlexAlgosGetResponse" } } } } }, "description": "Get all configurable flex algos under the current enterprise" } }, "/v1/gateways/{id}/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysIdDetailsGetResponse" } } } } } } }, "/v1/gateways/regions": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysRegionsGetResponse" } } } } } } }, "/v1/regions/{regionId}/gateways": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "regionId", "in": "path", "required": true, "description": "Graphiant region id", "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "storageProvider", "in": "query", "description": "Storage provider; only gateways with a LAN interface for this provider are returned", "required": true, "schema": { "type": "string", "example": "ENUM_VALUE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1RegionsRegionIdGatewaysGetResponse" } } } } }, "description": "List gateway appliances in a region with at least one LAN interface for the given storage provider" } }, "/v1/gateways/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysSummaryGetResponse" } } } } } } }, "/v1/global/ipfix/device": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpfixDeviceGetResponse" } } } } }, "description": "Get global ipfix exporters objects that failed to attach for a device" } }, "/v1/global/ntps/device": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalNtpsDeviceGetResponse" } } } } }, "description": "Get global ntp objects that failed to attach for a device" } }, "/v1/global/snmps/device": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSnmpsDeviceGetResponse" } } } } }, "description": "Get global snmp objects that failed to attach for a device" } }, "/v1/global/syslogs/device": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyslogsDeviceGetResponse" } } } } }, "description": "Get global syslog objects that failed to attach for a device" } }, "/v1/global/ipsec-profile/{id}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpsecProfileIdGetResponse" } } } } }, "description": "Get details of the configured global IPsec Profiles" } }, "/v1/global/ipsec-profile": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpsecProfileGetResponse" } } } } }, "description": "Get all the configured global IPsec Profiles for the current enterprise" } }, "/v1/global/ipfix": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpfixPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpfixPostResponse" } } } } }, "description": "Get configured global ipfix exporters" } }, "/v1/global/ipfix/site": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpfixSiteGetResponse" } } } } }, "description": "Get configured global ipfix exporters for a site" } }, "/v1/global/ntps": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalNtpsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalNtpsPostResponse" } } } } }, "description": "Get configured global ntps" } }, "/v1/global/ntps/site": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalNtpsSiteGetResponse" } } } } }, "description": "Get configured global ntps" } }, "/v1/global/device-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "ipfixExportedId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "ntpId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "prefixSetId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "routingPolicyId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "snmpId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "syslogServerId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "trafficPolicyId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalDeviceStatusGetResponse" } } } } }, "description": "Get status on global collector attached to devices" } }, "/v1/global/site-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "ipfixExportedSiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "ntpSiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "prefixSetSiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "routingPolicySiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "snmpSiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "syslogServerSiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "trafficPolicySiteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteStatusGetResponse" } } } } }, "description": "Get status on global objects attached to a site" } }, "/v1/global/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSummaryPostResponse" } } } } }, "description": "Get summary on global objects" } }, "/v1/global/prefix-sets": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalPrefixSetsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalPrefixSetsPostResponse" } } } } }, "description": "Get configured global prefix-sets" } }, "/v1/global/routing-policies": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalRoutingPoliciesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalRoutingPoliciesPostResponse" } } } } }, "description": "Get configured global routing-policies" } }, "/v1/global/snmps": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSnmpsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSnmpsPostResponse" } } } } }, "description": "Get configured global snmps" } }, "/v1/global/snmps/site": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSnmpsSiteGetResponse" } } } } }, "description": "Get configured global snmps" } }, "/v1/global/syslogs": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyslogsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyslogsPostResponse" } } } } }, "description": "Get configured global syslog collectors" } }, "/v1/global/syslogs/site": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyslogsSiteGetResponse" } } } } }, "description": "Get configured global syslog collectors" } }, "/v1/global/traffic-policies": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalTrafficPoliciesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalTrafficPoliciesPostResponse" } } } } }, "description": "Get configured global traffic-policies" } }, "/v1/global/apps/graphiant": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalAppsGraphiantGetResponse" } } } } }, "description": "Get all apps mapped by Graphiant" } }, "/v1/gateways/guest-consumer/{matchId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "email", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysGuestConsumerMatchIdGetResponse" } } } } }, "description": "Get Site to Site VPN information for a non-Graphiant guest consumer by their email" } }, "/v1/gateways/ipsec/regions/{regionId}/vrfs/{vrfId}/inside-subnet": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "regionId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "vrfId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "addressFamily", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysIpsecRegionsRegionIdVrfsVrfIdInsideSubnetGetResponse" } } } } }, "description": "Get the IPv4/Ipv6 Overlay Subnet for an ipsec gateway" } }, "/v1/devices/{deviceId}/interfaces": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdInterfacesGetResponse" } } } } }, "description": "Get interfaces for the given device" } }, "/v1/lldp/{interfaceId}/neighbors": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "interfaceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LldpInterfaceIdNeighborsGetResponse" } } } } }, "description": "Get the LLDP neighbors for an interface and optionally for a specific vendor" } }, "/v1/lldp/{interfaceId}/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "interfaceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LldpInterfaceIdSummaryGetResponse" } } } } }, "description": "Get the summary of LLDP neighbors for an interface" } }, "/v1/lldp/{interfaceId}/vendors": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "interfaceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LldpInterfaceIdVendorsGetResponse" } } } } }, "description": "Get the list LLDP vendors for an interface" } }, "/v1/global/lan-segments/{vrfId}/devices": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "vrfId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalLanSegmentsVrfIdDevicesGetResponse" } } } } }, "description": "Get a list of lan-segment devices under the currently logged in enterprise" } }, "/v1/lan-segments/interfaces/public": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "device id", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LanSegmentsInterfacesPublicGetResponse" } } } } }, "description": "Per LAN segment (VRF) on a device: interfaces split by globally routable IPv4 (for Public VIF / BGP)" } }, "/v1/msp/managed-enterprise-contract-info": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1MspManagedEnterpriseContractInfoGetResponse" } } } } }, "description": "Managed enterprises under the MSP with contract and credit allocation details for the requested month" } }, "/v1/devices/{deviceId}/ospfv2/defaultOriginate": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdOspfv2DefaultOriginateGetResponse" } } } } } } }, "/v1/devices/{deviceId}/ospfv3/defaultOriginate": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdOspfv3DefaultOriginateGetResponse" } } } } } } }, "/v1/presharedkey": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PresharedkeyGetResponse" } } } } }, "description": "Get all domain categories from the DPI engine" } }, "/v1/pvif/{id}/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Producer service id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifIdDetailsGetResponse" } } } } }, "description": "Get a gateway Public VIF service" } }, "/v1/pvif/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PvifSummaryGetResponse" } } } } }, "description": "List gateway Public VIF services" } }, "/v1/gateways/reference-consumer": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysReferenceConsumerGetResponse" } } } } }, "description": "Get the priorly-configured IPSec gateway details for a customer, lan segment, region combination to be re-used for any new service matches for that customer with the given lan segment and region" } }, "/v1/regions": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1RegionsGetResponse" } } } } }, "description": "Get regions used for the current enterprise" } }, "/v1/policy/route-tag-sets/tag-detail": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsTagDetailGetResponse" } } } } }, "description": "Get all the route tags summary for the the enterprise" } }, "/v1/policy/route-tag-sets/tags": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsTagsGetResponse" } } } } }, "description": "Get all the route tags for the enterprise" } }, "/v1/policy/route-tag-sets/tags-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1PolicyRouteTagSetsTagsSummaryGetResponse" } } } } }, "description": "Get all the route tags summary for the the enterprise" } }, "/v1/site/{id}/details/interfaces": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SiteIdDetailsInterfacesGetResponse" } } } } }, "description": "Get a list of a site's interfaces, loopback listed first" } }, "/v1/site/details/sitelists": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SiteDetailsSitelistsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SiteDetailsSitelistsPostResponse" } } } } }, "description": "Get a list of site list references for a site" } }, "/v1/global/site-lists/{id}/sites": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSiteListsIdSitesGetResponse" } } } } }, "description": "Get a details of a site list sites" } }, "/v1/global/ipsec-profile/{vpnProfileId}/site-to-site": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "vpnProfileId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalIpsecProfileVpnProfileIdSiteToSiteGetResponse" } } } } }, "description": "Get Site-to-site VPNs that are using the given global IPsec Profile" } }, "/v1/sites/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesDetailsGetResponse" } } } } }, "description": "Get a list of sites with aggregated values and site wide status" } }, "/v1/sites/map/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "lanSegmentIds", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": [ 0 ] }, "style": "form", "explode": true }, { "name": "siteIds", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": [ 0 ] }, "style": "form", "explode": true }, { "name": "siteListIds", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": [ 0 ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SitesMapDetailsGetResponse" } } } } }, "description": "Per LAN segment (VRF), sites touched by that segment and device lists with/without the segment on each site" } }, "/v1/devices/{deviceId}/slice/peers": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdSlicePeersGetResponse" } } } } } } }, "/v1/devices/{deviceId}/circuits/vrf-associations": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "circuitNames", "in": "query", "description": "Circuit name configured of wan interface", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "isp" }, "example": [ "isp" ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdCircuitsVrfAssociationsGetResponse" } } } } }, "description": "Get the VRF, interface, &, if relevant, loopback interfaces for a list of circuits" } }, "/v1/lan-segments": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "deviceIds", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": [ 0 ] }, "style": "form", "explode": true }, { "name": "filter", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "gatewayCloudProvider", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "ENUM_VALUE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LanSegmentsGetResponse" } } } } }, "description": "Get LAN Segments for the current enterprise" } }, "/v1/zones": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ZonesGetResponse" } } } } }, "description": "Get Zones for the current enterprise" } }, "/v1/extranet/b2b/matches/pause": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesPausePutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesPausePutResponse" } } } } }, "description": "Pause extranet service matches via customer summary" } }, "/v1/extranets/resolve-policy-target": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsResolvePolicyTargetPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsResolvePolicyTargetPostResponse" } } } } } } }, "/v1/extranet/b2b/customers/{id}/retry": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdRetryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bCustomersIdRetryPostResponse" } } } } }, "description": "Retry extranet service customer invite" } }, "/v1/extranet/b2b/producer/review": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerReviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerReviewPostResponse" } } } } }, "description": "Review inter-enterprise extranet service configuration" } }, "/v1/extranet/b2b/matches/review": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesReviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesReviewPostResponse" } } } } }, "description": "Review extranet service match" } }, "/v1/global/sync": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyncPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GlobalSyncPostResponse" } } } } }, "description": "Tries synching device with the global objects" } }, "/v1/extranets-b2b-peering/consumer/{id}/prefixes": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "consumer id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerIdPrefixesPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringConsumerIdPrefixesPutResponse" } } } } }, "description": "Update B2B extranet peering service consumer" } }, "/v1/extranets-b2b-peering/match/service-to-customer/service-status": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerServiceStatusPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetsB2bPeeringMatchServiceToCustomerServiceStatusPutResponse" } } } } }, "description": "Pause B2B match service to customer" } }, "/v1/version": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1VersionPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1VersionPostResponse" } } } } }, "description": "Update device config version" } }, "/v1/devices/{deviceId}/controller-peers": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdControllerPeersPutRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdControllerPeersPutResponse" } } } } }, "description": "Update peer list for controller" } }, "/v1/devices/{deviceId}/config": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdConfigPutRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdConfigPutResponse" } } } } }, "description": "Update a device" } }, "/v1/enterprise/contract": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseContractPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterpriseContractPutResponse" } } } } }, "description": "Update an enterprise (or MSP tenant) to use a new monthly or term-based contract. For MSPs, sets total pool credits and contract shape; per-managed-enterprise allocations are set via IAM CreateEnterprise / UpdateEnterprise." } }, "/v1/extranet/b2b/consumers/{id}/prefixes": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Consumer subscription id", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdPrefixesPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bConsumersIdPrefixesPutResponse" } } } } }, "description": "Update extranet service consumer prefix NAT (peering preset)" } }, "/v1/extranet/b2b/matches/{matchId}/status": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "matchId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdStatusPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMatchesMatchIdStatusPutResponse" } } } } }, "description": "Pause or resume an extranet service match" } }, "/v1/extranet/b2b/producer/{id}/status": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdStatusPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bProducerIdStatusPutResponse" } } } } }, "description": "Pause or resume an inter-enterprise extranet service" } }, "/v1/gateways/status": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysStatusPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1GatewaysStatusPostResponse" } } } } } } }, "/v1/devices/oauth": { "post": { "description": "Process OAuth client credentials for device onboarding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesOauthPostRequest" } } } }, "responses": { "200": { "description": "OAuth token generated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesOauthPostResponse" } } } }, "400": { "description": "Bad request - Invalid input" }, "500": { "description": "Internal server error" } } }, "get": { "description": "Redirect to OAuth authorization page for device onboarding", "parameters": [ { "in": "query", "name": "scope", "required": true, "schema": { "type": "string", "example": "type=zt-cpe uuid=device-uuid-123 hostname=device.example.com" }, "description": "OAuth scope containing device type, UUID, and hostname" }, { "in": "query", "name": "state", "schema": { "type": "string", "example": "state-12345" }, "description": "OAuth state parameter" }, { "in": "query", "name": "code_challenge", "schema": { "type": "string", "example": "code-challenge-12345" }, "description": "PKCE code challenge" }, { "in": "query", "name": "code_challenge_method", "schema": { "type": "string", "example": "S256" }, "description": "PKCE code challenge method" }, { "in": "query", "name": "pt", "schema": { "type": "string", "example": "hardware" }, "description": "Platform type" }, { "in": "query", "name": "bm", "schema": { "type": "string", "example": "p" }, "description": "Boot mode" } ], "responses": { "302": { "description": "Redirect to OAuth authorization page" }, "400": { "description": "Bad request - Invalid parameters" }, "500": { "description": "Internal server error" } } } }, "/v1/devices/oauth/authorization": { "get": { "description": "Process OAuth authorization for device onboarding", "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "query", "name": "relayState", "required": true, "schema": { "type": "string", "example": "eyJzY29wZSI6InR5cGU9enQtY3BlIHV1aWQ9ZGV2aWNlLXV1aWQtMTIzIGhvc3RuYW1lPWRldmljZS5leGFtcGxlLmNvbSIsInN0YXRlIjoic3RhdGUtMTIzNDUiLCJjb2RlX2NoYWxsZW5nZSI6ImNvZGUtY2hhbGxlbmdlLTEyMzQ1IiwiY29kZV9jaGFsbGVuZ2VfbWV0aG9kIjoiUzI1NiIsInB0IjoiaGFyZHdhcmUiLCJibSI6InAifQ==" }, "description": "Base64 encoded relay state containing OAuth parameters" } ], "responses": { "200": { "description": "Authorization code generated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesOauthAuthorizationGetResponse" } } } }, "400": { "description": "Bad request - Invalid relay state or parameters" }, "401": { "description": "Unauthorized - Invalid or missing token" }, "500": { "description": "Internal server error" } } } }, "/v1/devices/inventory/approve-return": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryApproveReturnPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryApproveReturnPostResponse" } } } } } } }, "/v1/devices/inventory/enterprise": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryEnterprisePutRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/devices/clear-new-flag": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesClearNewFlagPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesClearNewFlagPostResponse" } } } } } } }, "/v1/devices/inventory/clear-new-flag": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryClearNewFlagPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryClearNewFlagPostResponse" } } } } } } }, "/v1/devices/inventory/clear-return": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryClearReturnPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryClearReturnPostResponse" } } } } } } }, "/v1/onboarding/cloudinit": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1OnboardingCloudinitPostRequest" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1OnboardingCloudinitPostResponse" } } } } }, "description": "Create a onboarding token" }, "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "204": { "description": "No Content" } }, "description": "Delete the onboarding token" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1OnboardingCloudinitGetResponse" } } } } }, "description": "Get all the onboarding tokens" } }, "/v1/devices/bringup/token": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesBringupTokenPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesBringupTokenPostResponse" } } } } }, "description": "VM edge onboarding token" } }, "/v1/devices/inventory": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "notAssigned", "in": "query", "description": "", "required": false, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryGetResponse" } } } } } }, "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryPostResponse" } } } } } } }, "/v1/devices/bringup": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesBringupPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesBringupPostResponse" } } } } } }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesBringupPutRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/devices/rma": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesRmaPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesRmaPostResponse" } } } } } } }, "/v1/devices/inventory/serial-num": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceSerials", "in": "query", "description": "", "required": false, "schema": { "type": "array", "items": { "type": "string", "example": "example string" }, "example": [ "example" ] }, "style": "form", "explode": true } ], "responses": { "204": { "description": "No Content" } } } }, "/v1/devices/inventory/request-return": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryRequestReturnPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesInventoryRequestReturnPostResponse" } } } } } } }, "/v1/device-status/history": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceStatusHistoryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceStatusHistoryPostResponse" } } } } } } }, "/v1/device-status": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceStatusPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceStatusPostResponse" } } } } } } }, "/v1/enterprises/{enterpriseId}/device-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } }, { "name": "role", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "ENUM_VALUE" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EnterprisesEnterpriseIdDeviceStatusGetResponse" } } } } } } }, "/v1/devices/{deviceId}/arp": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdArpGetResponse" } } } } }, "description": "Get ARP monitoring table for a device" } }, "/v1/device/routing/bgp/nbrs/counters": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "address", "in": "query", "description": "BGP Nbr address", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "10.121.12.34" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingBgpNbrsCountersGetResponse" } } } } }, "description": "Get BGP Neighbor Counters" } }, "/v1/device/routing/bgp/nbrs/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "address", "in": "query", "description": "BGP Nbr address", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "10.121.12.34" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "interface", "in": "query", "description": "Interface name. Used in case of link local address", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "Ethernet3/0" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingBgpNbrsDetailsGetResponse" } } } } }, "description": "Get BGP Neighbor Details Table" } }, "/v1/device/routing/bgp/nbrid": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingBgpNbridGetResponse" } } } } }, "description": "Get BGP Neighbor ID Table" } }, "/v1/device/routing/odp/nbrid": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOdpNbridGetResponse" } } } } }, "description": "Get BGP Neighbor addresses from ODP server" } }, "/v1/device/routing/bgp/nbrs/per-afi-prefix": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "address", "in": "query", "description": "BGP Nbr address", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "10.121.12.34" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "interface", "in": "query", "description": "Interface name. Used in case of link local address", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "Ethernet3/0" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingBgpNbrsPerAfiPrefixGetResponse" } } } } }, "description": "Get BGP Neighbor Per Afi Prefix Counter" } }, "/v1/device/routing/vrf/bgp/route-count": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingVrfBgpRouteCountPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingVrfBgpRouteCountPostResponse" } } } } }, "description": "Get BGP VRF route count" } }, "/v1/device/routing/vrf/bgp/eibgp-route-count": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF names", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingVrfBgpEibgpRouteCountGetResponse" } } } } }, "description": "Get eBGP/iBGP VRF route count" } }, "/v1/devices/routing/vrf/protocol-route-count": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "protocols", "in": "query", "description": "List of protocols names for which route count is needed", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "[OSPF,BGP,connected]" }, "example": [ "[OSPF,BGP,connected]" ] }, "style": "form", "explode": true }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF names", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesRoutingVrfProtocolRouteCountGetResponse" } } } } }, "description": "Get per VRF per protocol route count" } }, "/v1/device/routing/rib/route-count": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF names", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "management" }, "example": [ "management" ] }, "style": "form", "explode": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingRibRouteCountPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingRibRouteCountPostResponse" } } } } }, "description": "Get BGP VRF installed route count" } }, "/v1/device/routing/ospfv2/areaid": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2AreaidGetResponse" } } } } }, "description": "Get OSPFv2 Area ID Table" } }, "/v1/device/routing/ospfv2/area/interface": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2AreaInterfaceGetResponse" } } } } }, "description": "Get OSPFv2 Area's Interface specific Information" } }, "/v1/device/routing/ospfv2/area/interface/nbrid": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "interfaceId", "in": "query", "description": "Valid configured Interface name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "ToATT, ISP2" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2AreaInterfaceNbridGetResponse" } } } } }, "description": "Get OSPFv2 Area's interface's Nbr ID table" } }, "/v1/device/routing/ospfv2/area/lsdb": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2AreaLsdbGetResponse" } } } } }, "description": "Get OSPFv2 Area specific LSDB Table" } }, "/v1/device/routing/ospfv2/area/nbr": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2AreaNbrGetResponse" } } } } }, "description": "Get OSPFv2 Area's Neighbors Information" } }, "/v1/device/routing/ospfv2/lsdb": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "ospf-demo" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2LsdbGetResponse" } } } } }, "description": "Get OSPFv2 global LSDB Table" } }, "/v1/device/routing/ospfv2/rib": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "BGP-ODP" }, { "name": "before", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } }, { "name": "last", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2RibGetResponse" } } } } }, "description": "Get OSPFv2 Local RIB Table" } }, "/v1/device/routing/ospfv2/statistics": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfNames", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "management" }, "example": [ "management" ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv2StatisticsGetResponse" } } } } }, "description": "Get OSPFv2 Statistics" } }, "/v1/device/routing/ospfv3/areaid": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3AreaidGetResponse" } } } } }, "description": "Get OSPFv3 Area ID Table" } }, "/v1/device/routing/ospfv3/area/interface": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3AreaInterfaceGetResponse" } } } } }, "description": "Get OSPFv3 Area's Interface specific Information" } }, "/v1/device/routing/ospfv3/area/lsdb": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3AreaLsdbGetResponse" } } } } }, "description": "Get OSPFv3 Area LSDB Table" } }, "/v1/device/routing/ospfv3/area/nbr": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "areaId", "in": "query", "description": "Valid configured Area ID", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "0.0.0.0" }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "OSPF1" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "default" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3AreaNbrGetResponse" } } } } }, "description": "Get OSPFv3 Area's Neighbors Information" } }, "/v1/device/routing/ospfv3/lsdb": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "ospf-demo" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3LsdbGetResponse" } } } } }, "description": "Get OSPFv3 global LSDB Table" } }, "/v1/device/routing/ospfv3/rib": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "instanceName", "in": "query", "description": "Valid configured OSPF Instance name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "BGP-ODP" }, { "name": "vrfName", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "management" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3RibGetResponse" } } } } }, "description": "Get OSPFv3 Local RIB Table" } }, "/v1/device/routing/ospfv3/statistics": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "query", "description": "Valid configured device ID > 0", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1000000 }, { "name": "vrfNames", "in": "query", "description": "Valid configured VRF name", "required": true, "schema": { "type": "array", "items": { "type": "string", "example": "management" }, "example": [ "management" ] }, "style": "form", "explode": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DeviceRoutingOspfv3StatisticsGetResponse" } } } } }, "description": "Get OSPFv3 Statistics" } }, "/v1/devices/{deviceId}/vrrp": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "groupId", "in": "query", "description": "VRRP configured group id", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 }, "example": 1000000 }, { "name": "interfaceName", "in": "query", "description": "interface name", "required": false, "schema": { "type": "string", "example": "example string" }, "example": "GigabitEthernet0/2" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesDeviceIdVrrpGetResponse" } } } } }, "description": "Get VRRP monitoring table for a device" } }, "/v1/edges-hardware/assigned": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EdgesHardwareAssignedGetResponse" } } } } } } }, "/v1/edges-summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "enterpriseId", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } }, { "name": "isRequested", "in": "query", "description": "", "required": false, "schema": { "type": "boolean", "example": true }, "example": true }, { "name": "upgradeSummary", "in": "query", "description": "", "required": false, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EdgesSummaryGetResponse" } } } } } }, "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EdgesSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EdgesSummaryPostResponse" } } } } } } }, "/v1/edges-hardware/unassigned": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1EdgesHardwareUnassignedGetResponse" } } } } } } }, "/v1/search": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "maxResults", "in": "query", "description": "", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123, "minimum": 0 } }, { "name": "search", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SearchGetResponse" } } } } } } }, "/v1/extranet-b2b-monitoring/peering-service/service-health": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceHealthPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1ExtranetB2bMonitoringPeeringServiceServiceHealthPostResponse" } } } } }, "description": "Returns connectivity status for a b2b peering service. Provides overall service connectivity status and detailed status for producer and customer prefixes for each consumer of the serviceShows whether the service is healthy, impaired, or down, and lists any missing prefixes in Impaired state. " } }, "/v2/monitoring/bfd": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringBfdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringBfdPostResponse" } } } } } } }, "/v2/monitoring/bgp": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringBgpPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringBgpPostResponse" } } } } } } }, "/v1/bwtracker/enterprise/csv": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseCsvPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseCsvPostResponse" } } } } } } }, "/v1/bwtracker/enterprise/details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseDetailsPostResponse" } } } } } } }, "/v1/bwtracker/enterprise/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerEnterpriseSummaryPostResponse" } } } } } } }, "/v1/bwtracker/region/edge/chart": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeChartPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeChartPostResponse" } } } } } } }, "/v1/bwtracker/region/edge/csv": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeCsvPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeCsvPostResponse" } } } } } } }, "/v1/bwtracker/region/edge/details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeDetailsPostResponse" } } } } } } }, "/v1/bwtracker/region/edge/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionEdgeSummaryPostResponse" } } } } } } }, "/v1/bwtracker/region/gateway/chart": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayChartPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayChartPostResponse" } } } } } } }, "/v1/bwtracker/region/gateway/csv": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayCsvPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayCsvPostResponse" } } } } } } }, "/v1/bwtracker/region/gateway/details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewayDetailsPostResponse" } } } } } } }, "/v1/bwtracker/region/gateway/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewaySummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionGatewaySummaryPostResponse" } } } } } } }, "/v1/bwtracker/region/site/chart": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteChartPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteChartPostResponse" } } } } } } }, "/v1/bwtracker/site/csv": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerSiteCsvPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerSiteCsvPostResponse" } } } } } } }, "/v1/bwtracker/region/site/details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteDetailsPostResponse" } } } } } } }, "/v1/bwtracker/region/site/gateway/chart": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewayChartPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewayChartPostResponse" } } } } } } }, "/v1/bwtracker/site/gateway/csv": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerSiteGatewayCsvPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerSiteGatewayCsvPostResponse" } } } } } } }, "/v1/bwtracker/region/site/gateway/details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewayDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewayDetailsPostResponse" } } } } } } }, "/v1/bwtracker/region/site/gateway/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewaySummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteGatewaySummaryPostResponse" } } } } } } }, "/v1/bwtracker/region/site/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BwtrackerRegionSiteSummaryPostResponse" } } } } } } }, "/v1/backbone-health/device/{deviceId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthDeviceDeviceIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthDeviceDeviceIdPostResponse" } } } } } } }, "/v1/backbone-health/et-wan-matrix": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthEtWanMatrixGetResponse" } } } } } } }, "/v1/backbone-health/etet-sla-matrix": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthEtetSlaMatrixGetResponse" } } } } } } }, "/v1/backbone-health/filter": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthFilterGetResponse" } } } } } } }, "/v1/backbone-health/overview": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthOverviewPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthOverviewPostResponse" } } } } } } }, "/v1/backbone-health/top-devices-by-alerts": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1BackboneHealthTopDevicesByAlertsPostResponse" } } } } } } }, "/v2/monitoring/circuits/bandwidth": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsBandwidthPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsBandwidthPostResponse" } } } } } } }, "/v2/monitoring/circuits/summary": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsSummaryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsSummaryPostResponse" } } } } } } }, "/v2/monitoring/circuits/utilization": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsUtilizationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsUtilizationPostResponse" } } } } } } }, "/v2/device/{deviceId}/topology": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeviceDeviceIdTopologyPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeviceDeviceIdTopologyPostResponse" } } } } }, "description": "Get the device topology" } }, "/v2/device/{deviceId}/lan-segments": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeviceDeviceIdLanSegmentsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2DeviceDeviceIdLanSegmentsPostResponse" } } } } }, "description": "Get route count for all the LAN Segments in a device" } }, "/v2/monitoring/extranet/service-status/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 }, { "name": "isProvider", "in": "query", "description": "whether the entity is a provider or consumer", "required": true, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetServiceStatusDetailsGetResponse" } } } } }, "description": "Returns a list of Site-to-ServerIPAddress statuses for a particular producer of consumer. Each element contains a Site object (with site information) and a mapping of Server Ip addresses to the corresponding Reachability status.Healthy status indicates all the edges/gateways within the Site can reach all the Server IP addresses.Impaired status indicates that some of the edges/gateways within the Site can reach only a subset of Server IP addresses.Down status indicates that none of the edges/gateways within the Site can reach any of the Server IP addresses." } }, "/v2/monitoring/extranet/service-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 }, { "name": "isProvider", "in": "query", "description": "whether the entity is a provider or consumer", "required": true, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetServiceStatusGetResponse" } } } } }, "description": "Returns a list of Status objects indicating the availability/reachability of all the Server IP addresses configured to the service. Healthy status indicates the Server IP address is reachable from all provider sites. Impaired status indicates the Server IP address is reachable from a subset of provider sites. Down status indicates the Server IP address can't be reached from any of the provider sites." } }, "/v2/monitoring/extranet/log-details": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetLogDetailsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetLogDetailsPostResponse" } } } } }, "description": "Returns connectivity logs for service monitoring. Includes timestamps for when connectivity from an edge/gateway to a Server IP address was lost or regained." } }, "/v2/monitoring/extranet/edge-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 }, { "name": "isProvider", "in": "query", "description": "whether the entity is a provider or consumer", "required": true, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetEdgeStatusGetResponse" } } } } }, "description": "Returns connectivity status for individual edges/gateways in extranet/ b2b application service monitoring. Provides granular view of which specific edges can reach server IP addresses. Shows per-edge connectivity status including healthy, impaired, or down states. Helps identify specific edge-level connectivity issues within sites." } }, "/v2/monitoring/extranet/status-details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 }, { "name": "isProvider", "in": "query", "description": "whether the entity is a provider or consumer", "required": true, "schema": { "type": "boolean", "example": true }, "example": true }, { "name": "serverAddress", "in": "query", "description": "the address of the server", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "192.168.1.1" }, { "name": "siteId", "in": "query", "description": "the id of the site", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetStatusDetailsGetResponse" } } } } }, "description": "Detailed view of the reachability of the Server IP addresses from the selected (producer or consumer) Site.Lists Site-to-ServerIPAddress statuses for the selected SiteLists Edge-to-ServerIPAddress statuses for All Edges within the selected Site.Returns physical Location of the SiteReturns Region of the Site." } }, "/v2/monitoring/extranet/site-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "query", "description": "the id associated with an entity - consumer_id for consumer, and service_id for the producer/service", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 1 }, { "name": "isProvider", "in": "query", "description": "whether the entity is a provider or consumer", "required": true, "schema": { "type": "boolean", "example": true }, "example": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringExtranetSiteStatusGetResponse" } } } } }, "description": "Returns a list of Statuses objects indicating the availability/reachability of the Server IP addresses from the Sites configured to the Provider or Consumer of the service.Healthy status indicates the Site can reach all the Server IP Addresses.Impaired status indicates that the Site can reach only a subset of Server IP addresses.Down status indicates the Site can reach none of the Server IP addresses." } }, "/v2/monitoring/ipsec": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringIpsecPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringIpsecPostResponse" } } } } } } }, "/v2/monitoring/ike-error-history": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringIkeErrorHistoryPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringIkeErrorHistoryPostResponse" } } } } } } }, "/v2/monitoring/interface": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringInterfacePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringInterfacePostResponse" } } } } } } }, "/v2/monitoring/macsec/{deviceId}/status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringMacsecDeviceIdStatusGetResponse" } } } } }, "description": "Returns the MACsec status for all interfaces on a device" } }, "/v2/monitoring/policy": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringPolicyPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringPolicyPostResponse" } } } } } } }, "/v2/monitoring/queue-instant": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringQueueInstantPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringQueueInstantPostResponse" } } } } } } }, "/v2/monitoring/segment-route-counts": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSegmentRouteCountsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSegmentRouteCountsPostResponse" } } } } } } }, "/v2/monitoring/site-circuits/bandwidth/{siteId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSiteCircuitsBandwidthSiteIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSiteCircuitsBandwidthSiteIdPostResponse" } } } } } } }, "/v1/troubleshooting/site-connectivity-status": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingSiteConnectivityStatusGetResponse" } } } } } } }, "/v2/monitoring/site-twamp/{siteId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 12345678910, "minimum": 0 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSiteTwampSiteIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSiteTwampSiteIdPostResponse" } } } } } } }, "/v2/site/{siteId}/topology": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SiteSiteIdTopologyPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SiteSiteIdTopologyPostResponse" } } } } }, "description": "Get the site topology" } }, "/v2/site/{siteId}/lan-segments": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SiteSiteIdLanSegmentsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2SiteSiteIdLanSegmentsPostResponse" } } } } }, "description": "Get route count for all the LAN Segments in a site" } }, "/v2/monitoring/system": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSystemPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringSystemPostResponse" } } } } } } }, "/v2/monitoring/twamp": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringTwampPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringTwampPostResponse" } } } } } } }, "/v2/monitoring/circuits/visualization": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsVisualizationPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2MonitoringCircuitsVisualizationPostResponse" } } } } } } }, "/v1/troubleshooting/device/{deviceId}": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "deviceId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingDeviceDeviceIdPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingDeviceDeviceIdPostResponse" } } } } } } }, "/v1/troubleshooting/enterprise": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingEnterprisePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingEnterprisePostResponse" } } } } } } }, "/v1/troubleshooting/filter": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingFilterGetResponse" } } } } } } }, "/v1/troubleshooting/site/{siteId}": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "siteId", "in": "path", "required": true, "description": "", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingSiteSiteIdGetResponse" } } } } } } }, "/v1/troubleshooting/top-sites-by-alerts": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1TroubleshootingTopSitesByAlertsPostResponse" } } } } } } }, "/v1/logs": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LogsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1LogsPostResponse" } } } } } } }, "/v1/devices/upgrade/cancel": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesUpgradeCancelPutRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/software/rollouts": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsPostResponse" } } } } }, "description": "Create upgrade rollout and returns rollout identifier" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsGetResponse" } } } } }, "description": "Returns all the configured upgrade rollouts" }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsPutRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsPutResponse" } } } } }, "description": "Modify update rollout" } }, "/v1/software/rollouts/{id}": { "delete": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Rollout identifier to delete.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 42 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsIdDeleteResponse" } } } } }, "description": "Delete given upgrade rollout" }, "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "id", "in": "path", "required": true, "description": "Rollout identifier to fetch.", "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "example": 42 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsIdGetResponse" } } } } }, "description": "Returns details about given upgrade rollout" } }, "/v1/software/auto-upgrade/default": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareAutoUpgradeDefaultGetResponse" } } } } } }, "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareAutoUpgradeDefaultPutRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/software/releases/download": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "imageExt", "in": "query", "description": "GNOS Image type (qcow2 or ova)", "required": true, "schema": { "type": "string", "example": "example string" }, "example": "qcow2" }, { "name": "version", "in": "query", "description": "GNOS Image version", "required": true, "schema": { "type": "string", "example": "example string" }, "example": 9999.202406130322 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareReleasesDownloadGetResponse" } } } } } } }, "/v1/software/releases/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareReleasesSummaryGetResponse" } } } } } } }, "/v1/devices/running/version": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesRunningVersionPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesRunningVersionPostResponse" } } } } } } }, "/v1/software/running/details": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "name": "runningVersion", "in": "query", "description": "", "required": false, "schema": { "type": "string", "example": "example string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRunningDetailsGetResponse" } } } } } } }, "/v1/software/running/summary": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRunningSummaryGetResponse" } } } } } } }, "/v1/software/rollouts/schedule": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsSchedulePostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareRolloutsSchedulePostResponse" } } } } }, "description": "Schedule rollout to upgrade now, later or user-triggered" } }, "/v1/devices/upgrade/schedule": { "put": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1DevicesUpgradeSchedulePutRequest" } } } }, "responses": { "204": { "description": "No Content" } } } }, "/v1/software/gcsrelease/upload/notes": { "post": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareGcsreleaseUploadNotesPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1SoftwareGcsreleaseUploadNotesPostResponse" } } } } } } }, "/v1/auth/login/pre": { "get": { "parameters": [ { "in": "query", "name": "email", "required": true, "schema": { "type": "string", "example": "user@example.com" }, "description": "User email address" }, { "in": "query", "name": "relayState", "required": false, "schema": { "type": "string", "example": "information-to-relay" }, "description": "State to relay after authentication" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPreGetResponse" } } } }, "400": { "description": "Bad request" } } } }, "/v1/auth/login/saml": { "get": { "parameters": [ { "in": "query", "name": "email", "required": true, "schema": { "type": "string", "example": "user@example.com" }, "description": "User email address" }, { "in": "query", "name": "relayState", "required": false, "schema": { "type": "string", "example": "information-to-relay" }, "description": "State to relay after authentication" } ], "responses": { "200": { "description": "Redirects to SAML identity provider" }, "401": { "description": "Missing email parameter", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Missing email query parameter" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Invalid email" } } } } } } } } }, "/v1/auth/login/callback": { "post": { "requestBody": { "required": true, "content": { "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/v1AuthLoginCallbackPostRequest" } } } }, "responses": { "302": { "description": "Redirects to portal with SSO token" }, "401": { "description": "Authentication failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthErrorPostResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Invalid saml response" } } } } } } } } }, "/v1/auth/user": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthUserGetResponse" } } } }, "403": { "description": "Forbidden" } } } }, "/v1/auth/login": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPostResponse" } } } }, "400": { "description": "Not Authenticated" }, "401": { "description": "Authenticated Failed" } } } }, "/v1/auth/login/temp": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginTempPostRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPostResponse" } } } }, "400": { "description": "Not Authenticated" } } } }, "/v1/auth/gcs": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthGcsPostRequest" } } } }, "responses": { "200": { "description": "Authentication successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthLoginPostResponse" } } } }, "400": { "description": "Bad request - Missing required fields", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1AuthErrorPostResponse" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Internal error" } } } } } } } } }, "/v1/auth/refresh": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "in": "query", "name": "currentPath", "required": false, "schema": { "type": "string", "example": "/dashboard" }, "description": "Current path to redirect to after refresh" } ], "responses": { "200": { "description": "Token refreshed successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/v1AuthLoginPostResponse" }, { "$ref": "#/components/schemas/v1AuthRefreshGetEntryPointResponse" } ] } } } }, "403": { "description": "Forbidden - Could not refresh token", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Could not refresh token" } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "error details" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Internal error" } } } } } } } } }, "/v1/auth/session": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " }, { "in": "query", "name": "enterpriseId", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1234567891011 }, "description": "Enterprise ID to get permissions for" } ], "responses": { "200": { "description": "Session updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "403": { "description": "Forbidden - Token expired", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Token expired" } } } } } }, "422": { "description": "Unprocessable Entity - GRPC error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "GRPC error details" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Internal error" } } } } } } } } }, "/v1/auth/session/root": { "get": { "security": [ { "jwtAuth": [] } ], "parameters": [ { "in": "header", "name": "Authorization", "required": true, "schema": { "type": "string" }, "description": "Bearer token. Format: Bearer " } ], "responses": { "200": { "description": "Session updated with root permissions successfully", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "403": { "description": "Forbidden - Token expired", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Token expired" } } } } } }, "422": { "description": "Unprocessable Entity - GRPC error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "GRPC error details" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Internal error" } } } } } } } } } }, "tags": [] }