{
"basePath": "/SEMP/v2/action",
"consumes": [
"application/json"
],
"definitions": {
"About": {
"properties": {},
"type": "object"
},
"AboutApi": {
"properties": {
"platform": {
"description": "The platform running the SEMP API.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "string",
"x-deprecated": false
},
"sempVersion": {
"description": "The version of the SEMP API.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"AboutApiLinks": {
"properties": {
"uri": {
"description": "The URI of this API Description object.",
"type": "string"
}
},
"type": "object"
},
"AboutApiResponse": {
"properties": {
"data": {
"$ref": "#/definitions/AboutApi"
},
"links": {
"$ref": "#/definitions/AboutApiLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"AboutLinks": {
"properties": {
"apiUri": {
"description": "The URI of this About's API Description object.",
"type": "string"
},
"uri": {
"description": "The URI of this About object.",
"type": "string"
},
"userUri": {
"description": "The URI of this About's User object.",
"type": "string"
}
},
"type": "object"
},
"AboutResponse": {
"properties": {
"data": {
"$ref": "#/definitions/About"
},
"links": {
"$ref": "#/definitions/AboutLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"AboutUser": {
"properties": {
"globalAccessLevel": {
"description": "The global access level of the User.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". The allowed values and their meaning are:\n\n\n\"admin\" - Full administrative access.\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n",
"enum": [
"admin",
"none",
"read-only",
"read-write"
],
"type": "string",
"x-deprecated": false
},
"sessionActive": {
"description": "Indicates whether a session is active for this request.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "boolean",
"x-deprecated": false
},
"sessionCreateTime": {
"description": "The timestamp of when the session was created.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"sessionCurrentTime": {
"description": "The current server timestamp. This is provided as a reference point for the other timestamps provided.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"sessionHardExpiryTime": {
"description": "The hard expiry time for the session. After this time the session will be invalid, regardless of activity.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"sessionId": {
"description": "An identifier for the session to differentiate this session from other sessions for the same user. This value is not guaranteed to be unique between active sessions for different users.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "string",
"x-deprecated": false
},
"sessionIdleExpiryTime": {
"description": "The session idle expiry time. After this time the session will be invalid if there has been no activity.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"username": {
"description": "The username of the User.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"AboutUserLinks": {
"properties": {
"logoutUri": {
"description": "The URI of this User's Logout action.",
"type": "string"
},
"msgVpnsUri": {
"description": "The URI of this User's collection of User Message VPN objects.",
"type": "string"
},
"uri": {
"description": "The URI of this User object.",
"type": "string"
}
},
"type": "object"
},
"AboutUserLogout": {
"properties": {},
"type": "object"
},
"AboutUserMsgVpn": {
"properties": {
"accessLevel": {
"description": "The Message VPN access level of the User.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\". The allowed values and their meaning are:\n\n\n\"none\" - No access.\n\"read-only\" - Read only access.\n\"read-write\" - Read and write access.\n
\n",
"enum": [
"none",
"read-only",
"read-write"
],
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/none\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"AboutUserMsgVpnLinks": {
"properties": {
"uri": {
"description": "The URI of this User Message VPN object.",
"type": "string"
}
},
"type": "object"
},
"AboutUserMsgVpnResponse": {
"properties": {
"data": {
"$ref": "#/definitions/AboutUserMsgVpn"
},
"links": {
"$ref": "#/definitions/AboutUserMsgVpnLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"AboutUserMsgVpnsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/AboutUserMsgVpn"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/AboutUserMsgVpnLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"AboutUserResponse": {
"properties": {
"data": {
"$ref": "#/definitions/AboutUser"
},
"links": {
"$ref": "#/definitions/AboutUserLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"Broker": {
"properties": {},
"type": "object"
},
"BrokerLinks": {
"properties": {
"aboutUri": {
"description": "The URI of this Broker's About object.",
"type": "string"
},
"certAuthoritiesUri": {
"description": "The URI of this Broker's collection of Certificate Authority objects. Deprecated. Replaced by clientCertAuthorities and domainCertAuthorities.",
"type": "string"
},
"clientCertAuthoritiesUri": {
"description": "The URI of this Broker's collection of Client Certificate Authority objects.",
"type": "string"
},
"configSyncAssertLeaderMsgVpnUri": {
"description": "The URI of this Broker's Assert Leader Message VPN action.",
"type": "string"
},
"configSyncAssertLeaderRouterUri": {
"description": "The URI of this Broker's Assert Leader Router action.",
"type": "string"
},
"configSyncResyncFollowerMsgVpnUri": {
"description": "The URI of this Broker's Resync Follower Message VPN action.",
"type": "string"
},
"configSyncResyncLeaderMsgVpnUri": {
"description": "The URI of this Broker's Resync Leader Message VPN action.",
"type": "string"
},
"configSyncResyncLeaderRouterUri": {
"description": "The URI of this Broker's Resync Leader Router action.",
"type": "string"
},
"guaranteedMsgingDefragmentMsgSpoolFilesStartUri": {
"description": "The URI of this Broker's Start Defragmentation action.",
"type": "string"
},
"guaranteedMsgingDefragmentMsgSpoolFilesStopUri": {
"description": "The URI of this Broker's Stop Defragmentation action.",
"type": "string"
},
"msgVpnsUri": {
"description": "The URI of this Broker's collection of Message VPN objects.",
"type": "string"
},
"oauthProfilesUri": {
"description": "The URI of this Broker's collection of OAuth Profile objects.",
"type": "string"
},
"sessionsUri": {
"description": "The URI of this Broker's collection of SEMP Session objects.",
"type": "string"
},
"uri": {
"description": "The URI of this Broker object.",
"type": "string"
}
},
"type": "object"
},
"BrokerResponse": {
"properties": {
"data": {
"$ref": "#/definitions/Broker"
},
"links": {
"$ref": "#/definitions/BrokerLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"CertAuthoritiesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/CertAuthority"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/CertAuthorityLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"CertAuthority": {
"properties": {
"certAuthorityName": {
"description": "The name of the Certificate Authority.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/read-only\". Deprecated. Replaced by clientCertAuthorities and domainCertAuthorities.",
"type": "string",
"x-deprecated": true
}
},
"type": "object"
},
"CertAuthorityLinks": {
"properties": {
"refreshCrlUri": {
"description": "The URI of this Certificate Authority's Refresh CRL action. Deprecated. Replaced by clientCertAuthorities.",
"type": "string"
},
"uri": {
"description": "The URI of this Certificate Authority object.",
"type": "string"
}
},
"type": "object"
},
"CertAuthorityRefreshCrl": {
"properties": {},
"type": "object"
},
"CertAuthorityResponse": {
"properties": {
"data": {
"$ref": "#/definitions/CertAuthority"
},
"links": {
"$ref": "#/definitions/CertAuthorityLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"ClientCertAuthoritiesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/ClientCertAuthority"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/ClientCertAuthorityLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"ClientCertAuthority": {
"properties": {
"certAuthorityName": {
"description": "The name of the Certificate Authority.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"ClientCertAuthorityLinks": {
"properties": {
"refreshCrlUri": {
"description": "The URI of this Client Certificate Authority's Refresh CRL action.",
"type": "string"
},
"uri": {
"description": "The URI of this Client Certificate Authority object.",
"type": "string"
}
},
"type": "object"
},
"ClientCertAuthorityRefreshCrl": {
"properties": {},
"type": "object"
},
"ClientCertAuthorityResponse": {
"properties": {
"data": {
"$ref": "#/definitions/ClientCertAuthority"
},
"links": {
"$ref": "#/definitions/ClientCertAuthorityLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"ConfigSyncAssertLeaderMsgVpn": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"ConfigSyncAssertLeaderRouter": {
"properties": {},
"type": "object"
},
"ConfigSyncResyncFollowerMsgVpn": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"ConfigSyncResyncLeaderMsgVpn": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"ConfigSyncResyncLeaderRouter": {
"properties": {},
"type": "object"
},
"GuaranteedMsgingDefragmentMsgSpoolFilesStart": {
"properties": {},
"type": "object"
},
"GuaranteedMsgingDefragmentMsgSpoolFilesStop": {
"properties": {},
"type": "object"
},
"MsgVpn": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnAuthenticationOauthProfile": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"oauthProfileName": {
"description": "The name of the OAuth profile.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnAuthenticationOauthProfileClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnAuthenticationOauthProfileLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this OAuth Profile's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this OAuth Profile object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnAuthenticationOauthProfileResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfile"
},
"links": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnAuthenticationOauthProfilesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfile"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfileLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnAuthenticationOauthProvider": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\". Deprecated. Replaced by authenticationOauthProfiles.",
"type": "string",
"x-deprecated": true
},
"oauthProviderName": {
"description": "The name of the OAuth Provider.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\". Deprecated. Replaced by authenticationOauthProfiles.",
"type": "string",
"x-deprecated": true
}
},
"type": "object"
},
"MsgVpnAuthenticationOauthProviderClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnAuthenticationOauthProviderLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this OAuth Provider's Clear Stats action. Deprecated. authenticationOauthProviders replaced by authenticationOauthProfiles.",
"type": "string"
},
"uri": {
"description": "The URI of this OAuth Provider object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnAuthenticationOauthProviderResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProvider"
},
"links": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnAuthenticationOauthProvidersResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProvider"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProviderLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnBridge": {
"properties": {
"bridgeName": {
"description": "The name of the Bridge.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"bridgeVirtualRouter": {
"description": "The virtual router of the Bridge.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\". The allowed values and their meaning are:\n\n\n\"primary\" - The Bridge is used for the primary virtual router.\n\"backup\" - The Bridge is used for the backup virtual router.\n\"auto\" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n",
"enum": [
"primary",
"backup",
"auto"
],
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnBridgeClearEvent": {
"properties": {
"eventName": {
"description": "The name of the event. The allowed values and their meaning are:\n\n\n\"ttl-exceeded\" - Time to live exceeded event.\n
\n",
"enum": [
"ttl-exceeded"
],
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnBridgeClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnBridgeDisconnect": {
"properties": {},
"type": "object"
},
"MsgVpnBridgeLinks": {
"properties": {
"clearEventUri": {
"description": "The URI of this Bridge's Clear Event action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Bridge's Clear Stats action.",
"type": "string"
},
"disconnectUri": {
"description": "The URI of this Bridge's Disconnect action.",
"type": "string"
},
"uri": {
"description": "The URI of this Bridge object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnBridgeResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnBridge"
},
"links": {
"$ref": "#/definitions/MsgVpnBridgeLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnBridgesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnBridge"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnBridgeLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnClearMsgSpoolStats": {
"properties": {},
"type": "object"
},
"MsgVpnClearReplicationStats": {
"properties": {},
"type": "object"
},
"MsgVpnClearServiceStats": {
"properties": {},
"type": "object"
},
"MsgVpnClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnClient": {
"properties": {
"clientName": {
"description": "The name of the Client.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnClientClearEvent": {
"properties": {
"eventName": {
"description": "The name of the event. The allowed values and their meaning are:\n\n\n\"large-message\" - The Client large message received event.\n\"message-too-big\" - The Client message too big event.\n\"parse-error\" - The Client parse error event.\n\"max-eliding-topic-count\" - The Client maximum eliding topics reached event.\n
\n",
"enum": [
"large-message",
"message-too-big",
"parse-error",
"max-eliding-topic-count"
],
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnClientClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnClientDisconnect": {
"properties": {},
"type": "object"
},
"MsgVpnClientLinks": {
"properties": {
"clearEventUri": {
"description": "The URI of this Client's Clear Event action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Client's Clear Stats action.",
"type": "string"
},
"disconnectUri": {
"description": "The URI of this Client's Disconnect action.",
"type": "string"
},
"transactedSessionsUri": {
"description": "The URI of this Client's collection of Client Transacted Session objects.",
"type": "string"
},
"uri": {
"description": "The URI of this Client object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnClientResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnClient"
},
"links": {
"$ref": "#/definitions/MsgVpnClientLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnClientTransactedSession": {
"properties": {
"clientName": {
"description": "The name of the Client.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"sessionName": {
"description": "The name of the Transacted Session.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnClientTransactedSessionDelete": {
"properties": {},
"type": "object"
},
"MsgVpnClientTransactedSessionLinks": {
"properties": {
"deleteUri": {
"description": "The URI of this Client Transacted Session's Delete action.",
"type": "string"
},
"uri": {
"description": "The URI of this Client Transacted Session object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnClientTransactedSessionResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnClientTransactedSession"
},
"links": {
"$ref": "#/definitions/MsgVpnClientTransactedSessionLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnClientTransactedSessionsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnClientTransactedSession"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnClientTransactedSessionLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnClientsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnClient"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnClientLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCache": {
"properties": {
"cacheName": {
"description": "The name of the Distributed Cache.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheCluster": {
"properties": {
"cacheName": {
"description": "The name of the Distributed Cache.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"clusterName": {
"description": "The name of the Cache Cluster.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstance": {
"properties": {
"cacheName": {
"description": "The name of the Distributed Cache.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"clusterName": {
"description": "The name of the Cache Cluster.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"instanceName": {
"description": "The name of the Cache Instance.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceBackupCachedMsgs": {
"properties": {
"filename": {
"description": "The filename for storing the cached messages.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceCancelBackupCachedMsgs": {
"properties": {},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceCancelRestoreCachedMsgs": {
"properties": {},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceClearEvent": {
"properties": {
"eventName": {
"description": "The name of the event. The allowed values and their meaning are:\n\n\n\"lost-message\" - Lost message event.\n
\n",
"enum": [
"lost-message"
],
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceDeleteMsgs": {
"properties": {
"topic": {
"description": "The topic covering the messages to delete.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceLinks": {
"properties": {
"backupCachedMsgsUri": {
"description": "The URI of this Cache Instance's Backup Cached Messages action.",
"type": "string"
},
"cancelBackupCachedMsgsUri": {
"description": "The URI of this Cache Instance's Cancel Backup Cached Messages action.",
"type": "string"
},
"cancelRestoreCachedMsgsUri": {
"description": "The URI of this Cache Instance's Cancel Restore Cached Messages action.",
"type": "string"
},
"clearEventUri": {
"description": "The URI of this Cache Instance's Clear Event action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Cache Instance's Clear Stats action.",
"type": "string"
},
"deleteMsgsUri": {
"description": "The URI of this Cache Instance's Delete Messages action.",
"type": "string"
},
"restoreCachedMsgsUri": {
"description": "The URI of this Cache Instance's Restore Cached Messages action.",
"type": "string"
},
"startUri": {
"description": "The URI of this Cache Instance's Start Cache Instance action.",
"type": "string"
},
"uri": {
"description": "The URI of this Cache Instance object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance"
},
"links": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceRestoreCachedMsgs": {
"properties": {
"filename": {
"description": "The filename for restoring the cached messages.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstanceStart": {
"properties": {},
"type": "object"
},
"MsgVpnDistributedCacheClusterInstancesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstance"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCacheClusterLinks": {
"properties": {
"instancesUri": {
"description": "The URI of this Cache Cluster's collection of Cache Instance objects.",
"type": "string"
},
"uri": {
"description": "The URI of this Cache Cluster object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnDistributedCacheClusterResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnDistributedCacheCluster"
},
"links": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCacheClustersResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCacheCluster"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCacheLinks": {
"properties": {
"clustersUri": {
"description": "The URI of this Distributed Cache's collection of Cache Cluster objects.",
"type": "string"
},
"uri": {
"description": "The URI of this Distributed Cache object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnDistributedCacheResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnDistributedCache"
},
"links": {
"$ref": "#/definitions/MsgVpnDistributedCacheLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnDistributedCachesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCache"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnDistributedCacheLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnKafkaReceiver": {
"properties": {
"kafkaReceiverName": {
"description": "The name of the Kafka Receiver.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnKafkaReceiverClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnKafkaReceiverLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this Kafka Receiver's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this Kafka Receiver object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnKafkaReceiverResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnKafkaReceiver"
},
"links": {
"$ref": "#/definitions/MsgVpnKafkaReceiverLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnKafkaReceiversResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnKafkaReceiver"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnKafkaReceiverLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnKafkaSender": {
"properties": {
"kafkaSenderName": {
"description": "The name of the Kafka Sender.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnKafkaSenderClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnKafkaSenderLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this Kafka Sender's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this Kafka Sender object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnKafkaSenderResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnKafkaSender"
},
"links": {
"$ref": "#/definitions/MsgVpnKafkaSenderLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnKafkaSendersResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnKafkaSender"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnKafkaSenderLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnLinks": {
"properties": {
"authenticationOauthProfilesUri": {
"description": "The URI of this Message VPN's collection of OAuth Profile objects.",
"type": "string"
},
"authenticationOauthProvidersUri": {
"description": "The URI of this Message VPN's collection of OAuth Provider objects. Deprecated. Replaced by authenticationOauthProfiles.",
"type": "string"
},
"bridgesUri": {
"description": "The URI of this Message VPN's collection of Bridge objects.",
"type": "string"
},
"clearMsgSpoolStatsUri": {
"description": "The URI of this Message VPN's Clear Stats action.",
"type": "string"
},
"clearReplicationStatsUri": {
"description": "The URI of this Message VPN's Clear Stats action.",
"type": "string"
},
"clearServiceStatsUri": {
"description": "The URI of this Message VPN's Clear Stats action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Message VPN's Clear Stats action.",
"type": "string"
},
"clientsUri": {
"description": "The URI of this Message VPN's collection of Client objects.",
"type": "string"
},
"distributedCachesUri": {
"description": "The URI of this Message VPN's collection of Distributed Cache objects.",
"type": "string"
},
"kafkaReceiversUri": {
"description": "The URI of this Message VPN's collection of Kafka Receiver objects.",
"type": "string"
},
"kafkaSendersUri": {
"description": "The URI of this Message VPN's collection of Kafka Sender objects.",
"type": "string"
},
"mqttSessionsUri": {
"description": "The URI of this Message VPN's collection of MQTT Session objects.",
"type": "string"
},
"queuesUri": {
"description": "The URI of this Message VPN's collection of Queue objects.",
"type": "string"
},
"replayLogsUri": {
"description": "The URI of this Message VPN's collection of Replay Log objects.",
"type": "string"
},
"restDeliveryPointsUri": {
"description": "The URI of this Message VPN's collection of REST Delivery Point objects.",
"type": "string"
},
"topicEndpointsUri": {
"description": "The URI of this Message VPN's collection of Topic Endpoint objects.",
"type": "string"
},
"transactionsUri": {
"description": "The URI of this Message VPN's collection of Replicated Local Transaction or XA Transaction objects.",
"type": "string"
},
"uri": {
"description": "The URI of this Message VPN object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnMqttSession": {
"properties": {
"mqttSessionClientId": {
"description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"mqttSessionVirtualRouter": {
"description": "The virtual router of the MQTT Session.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\". The allowed values and their meaning are:\n\n\n\"primary\" - The MQTT Session belongs to the primary virtual router.\n\"backup\" - The MQTT Session belongs to the backup virtual router.\n\"auto\" - The MQTT Session is automatically assigned a virtual router at creation, depending on the broker's active-standby role.\n
\n",
"enum": [
"primary",
"backup",
"auto"
],
"type": "string",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnMqttSessionClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnMqttSessionLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this MQTT Session's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this MQTT Session object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnMqttSessionResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnMqttSession"
},
"links": {
"$ref": "#/definitions/MsgVpnMqttSessionLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnMqttSessionsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnMqttSession"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnMqttSessionLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnQueue": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"queueName": {
"description": "The name of the Queue.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueCancelReplay": {
"properties": {
"forceComplete": {
"description": "Force cancellation to complete without waiting for client unbind ack.",
"type": "boolean",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnQueueCopyMsgFromQueue": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceQueueName": {
"description": "The name of the Queue to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueCopyMsgFromReplayLog": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceReplayLogName": {
"description": "The name of the Replay Log to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueCopyMsgFromTopicEndpoint": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceTopicEndpointName": {
"description": "The name of the Topic Endpoint to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueDeleteMsgs": {
"properties": {},
"type": "object"
},
"MsgVpnQueueLinks": {
"properties": {
"cancelReplayUri": {
"description": "The URI of this Queue's Cancel Replay action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Queue's Clear Stats action.",
"type": "string"
},
"copyMsgFromQueueUri": {
"description": "The URI of this Queue's Copy Message From Queue action.",
"type": "string"
},
"copyMsgFromReplayLogUri": {
"description": "The URI of this Queue's Copy Message From Replay Log action.",
"type": "string"
},
"copyMsgFromTopicEndpointUri": {
"description": "The URI of this Queue's Copy Message From Topic Endpoint action.",
"type": "string"
},
"deleteMsgsUri": {
"description": "The URI of this Queue's Delete All Messages action.",
"type": "string"
},
"msgsUri": {
"description": "The URI of this Queue's collection of Queue Message objects.",
"type": "string"
},
"startReplayUri": {
"description": "The URI of this Queue's Start Replay action.",
"type": "string"
},
"uri": {
"description": "The URI of this Queue object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnQueueMsg": {
"properties": {
"msgId": {
"description": "The identifier (ID) of the Message.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"format": "int64",
"type": "integer",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"queueName": {
"description": "The name of the Queue.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueueMsgDelete": {
"properties": {},
"type": "object"
},
"MsgVpnQueueMsgLinks": {
"properties": {
"deleteUri": {
"description": "The URI of this Queue Message's Delete action.",
"type": "string"
},
"uri": {
"description": "The URI of this Queue Message object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnQueueMsgResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnQueueMsg"
},
"links": {
"$ref": "#/definitions/MsgVpnQueueMsgLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnQueueMsgsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnQueueMsg"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnQueueMsgLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnQueueResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnQueue"
},
"links": {
"$ref": "#/definitions/MsgVpnQueueLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnQueueStartReplay": {
"properties": {
"afterMsg": {
"description": "The Message after which to begin replay, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"fromTime": {
"description": "The time to begin replaying messages from. The value must be no less than the time that the replay log was created. To play back the whole log, this parameter must be omitted. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"replayLogName": {
"description": "The name of the Replay Log.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnQueuesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnQueue"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnQueueLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnReplayLog": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"replayLogName": {
"description": "The name of the Replay Log.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnReplayLogLinks": {
"properties": {
"trimLoggedMsgsUri": {
"description": "The URI of this Replay Log's Trim Logged Messages action.",
"type": "string"
},
"uri": {
"description": "The URI of this Replay Log object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnReplayLogResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnReplayLog"
},
"links": {
"$ref": "#/definitions/MsgVpnReplayLogLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnReplayLogTrimLoggedMsgs": {
"properties": {
"olderThanTime": {
"description": "The time to use for trimming older messages. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnReplayLogsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnReplayLog"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnReplayLogLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpn"
},
"links": {
"$ref": "#/definitions/MsgVpnLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnRestDeliveryPoint": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"restDeliveryPointName": {
"description": "The name of the REST Delivery Point.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnRestDeliveryPointLinks": {
"properties": {
"restConsumersUri": {
"description": "The URI of this REST Delivery Point's collection of REST Consumer objects.",
"type": "string"
},
"uri": {
"description": "The URI of this REST Delivery Point object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnRestDeliveryPointResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnRestDeliveryPoint"
},
"links": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnRestDeliveryPointRestConsumer": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"restConsumerName": {
"description": "The name of the REST Consumer.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"restDeliveryPointName": {
"description": "The name of the REST Delivery Point.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnRestDeliveryPointRestConsumerClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnRestDeliveryPointRestConsumerLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this REST Consumer's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this REST Consumer object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnRestDeliveryPointRestConsumerResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer"
},
"links": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnRestDeliveryPointRestConsumersResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumer"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnRestDeliveryPointsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnRestDeliveryPoint"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTopicEndpoint": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"topicEndpointName": {
"description": "The name of the Topic Endpoint.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointCancelReplay": {
"properties": {
"forceComplete": {
"description": "Force cancellation to complete without waiting for client unbind ack.",
"type": "boolean",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointClearStats": {
"properties": {},
"type": "object"
},
"MsgVpnTopicEndpointCopyMsgFromQueue": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceQueueName": {
"description": "The name of the Queue to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointCopyMsgFromReplayLog": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceReplayLogName": {
"description": "The name of the Replay Log to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointCopyMsgFromTopicEndpoint": {
"properties": {
"replicationGroupMsgId": {
"description": "The Message to copy, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"sourceTopicEndpointName": {
"description": "The name of the Topic Endpoint to copy the message from.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointDeleteMsgs": {
"properties": {},
"type": "object"
},
"MsgVpnTopicEndpointLinks": {
"properties": {
"cancelReplayUri": {
"description": "The URI of this Topic Endpoint's Cancel Replay action.",
"type": "string"
},
"clearStatsUri": {
"description": "The URI of this Topic Endpoint's Clear Stats action.",
"type": "string"
},
"copyMsgFromQueueUri": {
"description": "The URI of this Topic Endpoint's Copy Message From Queue action.",
"type": "string"
},
"copyMsgFromReplayLogUri": {
"description": "The URI of this Topic Endpoint's Copy Message From Replay Log action.",
"type": "string"
},
"copyMsgFromTopicEndpointUri": {
"description": "The URI of this Topic Endpoint's Copy Message From Topic Endpoint action.",
"type": "string"
},
"deleteMsgsUri": {
"description": "The URI of this Topic Endpoint's Delete All Messages action.",
"type": "string"
},
"msgsUri": {
"description": "The URI of this Topic Endpoint's collection of Topic Endpoint Message objects.",
"type": "string"
},
"startReplayUri": {
"description": "The URI of this Topic Endpoint's Start Replay action.",
"type": "string"
},
"uri": {
"description": "The URI of this Topic Endpoint object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnTopicEndpointMsg": {
"properties": {
"msgId": {
"description": "The identifier (ID) of the Message.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"format": "int64",
"type": "integer",
"x-deprecated": false
},
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"topicEndpointName": {
"description": "The name of the Topic Endpoint.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointMsgDelete": {
"properties": {},
"type": "object"
},
"MsgVpnTopicEndpointMsgLinks": {
"properties": {
"deleteUri": {
"description": "The URI of this Topic Endpoint Message's Delete action.",
"type": "string"
},
"uri": {
"description": "The URI of this Topic Endpoint Message object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnTopicEndpointMsgResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsg"
},
"links": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsgLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTopicEndpointMsgsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsg"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsgLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTopicEndpointResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnTopicEndpoint"
},
"links": {
"$ref": "#/definitions/MsgVpnTopicEndpointLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTopicEndpointStartReplay": {
"properties": {
"afterMsg": {
"description": "The Message after which to begin replay, identified by its Replication Group Message ID.",
"type": "string",
"x-deprecated": false
},
"fromTime": {
"description": "The time to begin replaying messages from. This value represents the number of seconds since 1970-01-01 00:00:00 UTC (Unix time).",
"format": "int32",
"type": "integer",
"x-deprecated": false
},
"replayLogName": {
"description": "The name of the Replay Log.",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTopicEndpointsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnTopicEndpoint"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnTopicEndpointLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTransaction": {
"properties": {
"msgVpnName": {
"description": "The name of the Message VPN.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
},
"xid": {
"description": "The identifier (ID) of the Transaction.\n\nThe minimum access scope/level required to retrieve this attribute is \"vpn/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"MsgVpnTransactionCommit": {
"properties": {},
"type": "object"
},
"MsgVpnTransactionDelete": {
"properties": {},
"type": "object"
},
"MsgVpnTransactionLinks": {
"properties": {
"commitUri": {
"description": "The URI of this Replicated Local Transaction or XA Transaction's Commit action.",
"type": "string"
},
"deleteUri": {
"description": "The URI of this Replicated Local Transaction or XA Transaction's Delete action.",
"type": "string"
},
"rollbackUri": {
"description": "The URI of this Replicated Local Transaction or XA Transaction's Rollback action.",
"type": "string"
},
"uri": {
"description": "The URI of this Replicated Local Transaction or XA Transaction object.",
"type": "string"
}
},
"type": "object"
},
"MsgVpnTransactionResponse": {
"properties": {
"data": {
"$ref": "#/definitions/MsgVpnTransaction"
},
"links": {
"$ref": "#/definitions/MsgVpnTransactionLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnTransactionRollback": {
"properties": {},
"type": "object"
},
"MsgVpnTransactionsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpnTransaction"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnTransactionLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"MsgVpnsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/MsgVpn"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/MsgVpnLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"OauthProfile": {
"properties": {
"oauthProfileName": {
"description": "The name of the OAuth profile.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"OauthProfileClearStats": {
"properties": {},
"type": "object"
},
"OauthProfileLinks": {
"properties": {
"clearStatsUri": {
"description": "The URI of this OAuth Profile's Clear Stats action.",
"type": "string"
},
"uri": {
"description": "The URI of this OAuth Profile object.",
"type": "string"
}
},
"type": "object"
},
"OauthProfileResponse": {
"properties": {
"data": {
"$ref": "#/definitions/OauthProfile"
},
"links": {
"$ref": "#/definitions/OauthProfileLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"OauthProfilesResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/OauthProfile"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/OauthProfileLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"SempError": {
"properties": {
"code": {
"description": "The error code which uniquely identifies the error that has occurred.",
"format": "int32",
"type": "integer"
},
"description": {
"description": "The verbose description of the problem.",
"type": "string"
},
"status": {
"description": "The terse status string associated with `code`.",
"type": "string"
}
},
"required": [
"code",
"status",
"description"
],
"type": "object"
},
"SempMeta": {
"properties": {
"count": {
"description": "The total number of objects requested, irrespective of page size. This may be a count of all objects in a collection or a filtered subset. It represents a snapshot in time and may change when paging through results.\n\nThis attribute is only supported for [specific collections](https://docs.solace.com/Admin/SEMP/SEMP-Features.htm#retrieving-the-number-of-objects-in-a-collection).",
"format": "int64",
"type": "integer"
},
"error": {
"$ref": "#/definitions/SempError"
},
"paging": {
"$ref": "#/definitions/SempPaging"
},
"request": {
"$ref": "#/definitions/SempRequest"
},
"responseCode": {
"description": "The HTTP response code, one of 200 (success), 4xx (client error), or 5xx (server error).",
"format": "int32",
"type": "integer"
}
},
"required": [
"request",
"responseCode"
],
"type": "object"
},
"SempMetaOnlyResponse": {
"properties": {
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"SempPaging": {
"properties": {
"cursorQuery": {
"description": "The cursor, or position, for the next page of objects. Use this as the `cursor` query parameter of the next request.",
"type": "string"
},
"nextPageUri": {
"description": "The URI of the next page of objects. `cursorQuery` is already embedded within this URI.",
"type": "string"
}
},
"required": [
"cursorQuery",
"nextPageUri"
],
"type": "object"
},
"SempRequest": {
"properties": {
"method": {
"description": "The HTTP method of the request which resulted in this response.",
"type": "string"
},
"uri": {
"description": "The URI of the request which resulted in this response. The URI may be normalized.",
"type": "string"
}
},
"required": [
"method"
],
"type": "object"
},
"Session": {
"properties": {
"sessionId": {
"description": "The unique identifier for the session.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/read-only\".",
"type": "string",
"x-deprecated": false
},
"sessionUsername": {
"description": "The username used for authorization.\n\nThe minimum access scope/level required to retrieve this attribute is \"global/read-only\".",
"type": "string",
"x-deprecated": false
}
},
"type": "object"
},
"SessionDelete": {
"properties": {},
"type": "object"
},
"SessionLinks": {
"properties": {
"deleteUri": {
"description": "The URI of this SEMP Session's Delete action.",
"type": "string"
},
"uri": {
"description": "The URI of this SEMP Session object.",
"type": "string"
}
},
"type": "object"
},
"SessionResponse": {
"properties": {
"data": {
"$ref": "#/definitions/Session"
},
"links": {
"$ref": "#/definitions/SessionLinks"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
},
"SessionsResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/Session"
},
"type": "array"
},
"links": {
"items": {
"$ref": "#/definitions/SessionLinks"
},
"type": "array"
},
"meta": {
"$ref": "#/definitions/SempMeta"
}
},
"required": [
"meta"
],
"type": "object"
}
},
"host": "www.solace.com",
"info": {
"contact": {
"email": "support@solace.com",
"name": "Solace",
"url": "http://www.solace.com"
},
"description": "SEMP (starting in `v2`) is a RESTful API for configuring, monitoring, and administering a Solace Event Broker. This specification defines the following API:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nAction|/SEMP/v2/action|Performing actions\n\n\n\nThe following APIs are also available:\n\n\nAPI|Base Path|Purpose\n:---|:---|:---\nConfiguration|/SEMP/v2/config|Reading and writing configuration\nMonitoring|/SEMP/v2/monitor|Querying operational state\n\n\n\nFor tutorials, architectural and protocol design documentation, and other information about the SEMP API, consult the [SEMP documentation](https://docs.solace.com/Admin/SEMP/Using-SEMP.htm) on the Solace website. The SEMP API specifications are also [available for download](https://solace.com/downloads/).\n\nIf you need additional support, please contact us at [support@solace.com](mailto:support@solace.com).",
"title": "SEMP (Solace Element Management Protocol)",
"version": "10.25.21.6767"
},
"parameters": {
"countQuery": {
"default": 10,
"description": "Limit the count of objects in the response. See the documentation for the `count` parameter.",
"in": "query",
"minimum": 1,
"name": "count",
"required": false,
"type": "integer"
},
"cursorQuery": {
"description": "The cursor, or position, for the next page of objects. See the documentation for the `cursor` parameter.",
"in": "query",
"name": "cursor",
"required": false,
"type": "string"
},
"selectQuery": {
"collectionFormat": "csv",
"description": "Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the `select` parameter.",
"in": "query",
"items": {
"type": "string"
},
"name": "select",
"required": false,
"type": "array"
},
"whereQuery": {
"collectionFormat": "csv",
"description": "Include in the response only objects where certain conditions are true. See the the documentation for the `where` parameter.",
"in": "query",
"items": {
"type": "string"
},
"name": "where",
"required": false,
"type": "array"
}
},
"paths": {
"/": {
"get": {
"description": "Get a Broker object.\n\nThis object contains global configuration for the message broker.\n\n\n\nThe minimum access scope/level required to perform this operation is determined by the attributes retrieved.",
"operationId": "getBroker",
"parameters": [
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Broker object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/BrokerResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Broker object.",
"tags": [
"all"
]
}
},
"/about": {
"get": {
"description": "Get an About object.\n\nThis provides metadata about the SEMP API, such as the version of the API supported by the broker.\n\n\n\nThe minimum access scope/level required to perform this operation is determined by the attributes retrieved.",
"operationId": "getAbout",
"parameters": [
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The About object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/AboutResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an About object.",
"tags": [
"all",
"about"
]
}
},
"/about/api": {
"get": {
"description": "Get an API Description object.\n\nThe API Description object provides metadata about the SEMP API.\n\n\n\nThe minimum access scope/level required to perform this operation is determined by the attributes retrieved.",
"operationId": "getAboutApi",
"parameters": [
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The API Description object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/AboutApiResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an API Description object.",
"tags": [
"all",
"about"
]
}
},
"/about/user": {
"get": {
"description": "Get a User object.\n\nSession and access level information about the user accessing the SEMP API.\n\n\n\nThe minimum access scope/level required to perform this operation is determined by the attributes retrieved.",
"operationId": "getAboutUser",
"parameters": [
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The User object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/AboutUserResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a User object.",
"tags": [
"all",
"about"
]
}
},
"/about/user/logout": {
"put": {
"description": "Logout of the current session.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/none\".",
"operationId": "doAboutUserLogout",
"parameters": [
{
"description": "The Logout action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AboutUserLogout"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Logout of the current session.",
"tags": [
"all",
"about"
]
}
},
"/about/user/msgVpns": {
"get": {
"description": "Get a list of User Message VPN objects.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/none\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getAboutUserMsgVpns",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of User Message VPN objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/AboutUserMsgVpnsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of User Message VPN objects.",
"tags": [
"all",
"about"
]
}
},
"/about/user/msgVpns/{msgVpnName}": {
"get": {
"description": "Get a User Message VPN object.\n\nThis provides information about the Message VPN access level for the username used to access the SEMP API.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/none\".",
"operationId": "getAboutUserMsgVpn",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The User Message VPN object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/AboutUserMsgVpnResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a User Message VPN object.",
"tags": [
"all",
"about"
]
}
},
"/certAuthorities": {
"get": {
"deprecated": true,
"description": "Get a list of Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.\n\nDeprecated. Replaced by clientCertAuthorities and domainCertAuthorities.",
"operationId": "getCertAuthorities",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Certificate Authority objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/CertAuthoritiesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Certificate Authority objects.",
"tags": [
"all",
"certAuthority"
]
}
},
"/certAuthorities/{certAuthorityName}": {
"get": {
"deprecated": true,
"description": "Get a Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\ncertAuthorityName|x|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".\n\nDeprecated. Replaced by clientCertAuthorities and domainCertAuthorities.",
"operationId": "getCertAuthority",
"parameters": [
{
"description": "The name of the Certificate Authority.",
"in": "path",
"name": "certAuthorityName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Certificate Authority object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/CertAuthorityResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Certificate Authority object.",
"tags": [
"all",
"certAuthority"
]
}
},
"/certAuthorities/{certAuthorityName}/refreshCrl": {
"put": {
"deprecated": true,
"description": "Refresh the CRL file for the Certificate Authority.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-write\".\n\nDeprecated. Replaced by clientCertAuthorities.",
"operationId": "doCertAuthorityRefreshCrl",
"parameters": [
{
"description": "The name of the Certificate Authority.",
"in": "path",
"name": "certAuthorityName",
"required": true,
"type": "string"
},
{
"description": "The Refresh CRL action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CertAuthorityRefreshCrl"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Refresh the CRL file for the Certificate Authority.",
"tags": [
"all",
"certAuthority"
]
}
},
"/clientCertAuthorities": {
"get": {
"description": "Get a list of Client Certificate Authority objects.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getClientCertAuthorities",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Client Certificate Authority objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/ClientCertAuthoritiesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Client Certificate Authority objects.",
"tags": [
"all",
"clientCertAuthority"
]
}
},
"/clientCertAuthorities/{certAuthorityName}": {
"get": {
"description": "Get a Client Certificate Authority object.\n\nClients can authenticate with the message broker over TLS by presenting a valid client certificate. The message broker authenticates the client certificate by constructing a full certificate chain (from the client certificate to intermediate CAs to a configured root CA). The intermediate CAs in this chain can be provided by the client, or configured in the message broker. The root CA must be configured on the message broker.\n\n\nAttribute|Identifying\n:---|:---:\ncertAuthorityName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".",
"operationId": "getClientCertAuthority",
"parameters": [
{
"description": "The name of the Certificate Authority.",
"in": "path",
"name": "certAuthorityName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Client Certificate Authority object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/ClientCertAuthorityResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Client Certificate Authority object.",
"tags": [
"all",
"clientCertAuthority"
]
}
},
"/clientCertAuthorities/{certAuthorityName}/refreshCrl": {
"put": {
"description": "Refresh the CRL file for the Client Certificate Authority.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/mesh-manager\".",
"operationId": "doClientCertAuthorityRefreshCrl",
"parameters": [
{
"description": "The name of the Certificate Authority.",
"in": "path",
"name": "certAuthorityName",
"required": true,
"type": "string"
},
{
"description": "The Refresh CRL action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ClientCertAuthorityRefreshCrl"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Refresh the CRL file for the Client Certificate Authority.",
"tags": [
"all",
"clientCertAuthority"
]
}
},
"/configSyncAssertLeaderMsgVpn": {
"put": {
"description": "Assert leadership of the specified Config Sync table, forcing any other leader's content to be overwritten with our own. Use whenever a High Availability pair fall out of sync. Config Sync must be a leader for the selected table.\n\n\nAttribute|Required\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doConfigSyncAssertLeaderMsgVpn",
"parameters": [
{
"description": "The Assert Leader Message VPN action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ConfigSyncAssertLeaderMsgVpn"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Assert leadership of the specified Config Sync table, forcing any other leader's content to be overwritten with our own. Use whenever a High Availability pair fall out of sync. Config Sync must be a leader for the selected table.",
"tags": [
"all"
]
}
},
"/configSyncAssertLeaderRouter": {
"put": {
"description": "Assert leadership of the specified Config Sync table, forcing any other leader's content to be overwritten with our own. Use whenever a High Availability pair fall out of sync. Config Sync must be a leader for the selected table.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-write\".",
"operationId": "doConfigSyncAssertLeaderRouter",
"parameters": [
{
"description": "The Assert Leader Router action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ConfigSyncAssertLeaderRouter"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Assert leadership of the specified Config Sync table, forcing any other leader's content to be overwritten with our own. Use whenever a High Availability pair fall out of sync. Config Sync must be a leader for the selected table.",
"tags": [
"all"
]
}
},
"/configSyncResyncFollowerMsgVpn": {
"put": {
"description": "Resync the selected Config Sync table, forcing this follower's content to be overwritten with that from a leader. Config Sync must be a follower for the selected table.\n\n\nAttribute|Required\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doConfigSyncResyncFollowerMsgVpn",
"parameters": [
{
"description": "The Resync Follower Message VPN action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ConfigSyncResyncFollowerMsgVpn"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Resync the selected Config Sync table, forcing this follower's content to be overwritten with that from a leader. Config Sync must be a follower for the selected table.",
"tags": [
"all"
]
}
},
"/configSyncResyncLeaderMsgVpn": {
"put": {
"description": "Resync the selected Config Sync table, forcing this leader's content to be overwritten with that from a leader. Config Sync must be a leader for the selected table.\n\n\nAttribute|Required\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doConfigSyncResyncLeaderMsgVpn",
"parameters": [
{
"description": "The Resync Leader Message VPN action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ConfigSyncResyncLeaderMsgVpn"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Resync the selected Config Sync table, forcing this leader's content to be overwritten with that from a leader. Config Sync must be a leader for the selected table.",
"tags": [
"all"
]
}
},
"/configSyncResyncLeaderRouter": {
"put": {
"description": "Resync the selected Config Sync table, forcing this leader's content to be overwritten with that from a leader. Config Sync must be a leader for the selected table.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-write\".",
"operationId": "doConfigSyncResyncLeaderRouter",
"parameters": [
{
"description": "The Resync Leader Router action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ConfigSyncResyncLeaderRouter"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Resync the selected Config Sync table, forcing this leader's content to be overwritten with that from a leader. Config Sync must be a leader for the selected table.",
"tags": [
"all"
]
}
},
"/guaranteedMsgingDefragmentMsgSpoolFilesStart": {
"put": {
"description": "Start a spool file defragmentation run.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/mesh-manager\".",
"operationId": "doGuaranteedMsgingDefragmentMsgSpoolFilesStart",
"parameters": [
{
"description": "The Start Defragmentation action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GuaranteedMsgingDefragmentMsgSpoolFilesStart"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Start a spool file defragmentation run.",
"tags": [
"all"
]
}
},
"/guaranteedMsgingDefragmentMsgSpoolFilesStop": {
"put": {
"description": "Stop a spool file defragmentation run.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/mesh-manager\".",
"operationId": "doGuaranteedMsgingDefragmentMsgSpoolFilesStop",
"parameters": [
{
"description": "The Stop Defragmentation action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GuaranteedMsgingDefragmentMsgSpoolFilesStop"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Stop a spool file defragmentation run.",
"tags": [
"all"
]
}
},
"/msgVpns": {
"get": {
"description": "Get a list of Message VPN objects.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpns",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Message VPN objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Message VPN objects.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}": {
"get": {
"description": "Get a Message VPN object.\n\nMessage VPNs (Virtual Private Networks) allow for the segregation of topic space and clients. They also group clients connecting to a network of message brokers, such that messages published within a particular group are only visible to that group's clients.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpn",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Message VPN object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Message VPN object.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProfiles": {
"get": {
"description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 500.",
"operationId": "getMsgVpnAuthenticationOauthProfiles",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of OAuth Profile objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfilesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of OAuth Profile objects.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProfile"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}": {
"get": {
"description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\noauthProfileName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnAuthenticationOauthProfile",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the OAuth profile.",
"in": "path",
"name": "oauthProfileName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The OAuth Profile object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfileResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an OAuth Profile object.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProfile"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProfiles/{oauthProfileName}/clearStats": {
"put": {
"description": "Clear the statistics for the OAuth Profile.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnAuthenticationOauthProfileClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the OAuth profile.",
"in": "path",
"name": "oauthProfileName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProfileClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the OAuth Profile.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProfile"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProviders": {
"get": {
"deprecated": true,
"description": "Get a list of OAuth Provider objects.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\noauthProviderName|x|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 500.\n\nDeprecated. Replaced by authenticationOauthProfiles.",
"operationId": "getMsgVpnAuthenticationOauthProviders",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of OAuth Provider objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProvidersResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of OAuth Provider objects.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProvider"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}": {
"get": {
"deprecated": true,
"description": "Get an OAuth Provider object.\n\nOAuth Providers contain information about the issuer of an OAuth token that is needed to validate the token and derive a client username from it.\n\n\nAttribute|Identifying|Deprecated\n:---|:---:|:---:\nmsgVpnName|x|x\noauthProviderName|x|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nDeprecated. Replaced by authenticationOauthProfiles.",
"operationId": "getMsgVpnAuthenticationOauthProvider",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the OAuth Provider.",
"in": "path",
"name": "oauthProviderName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The OAuth Provider object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProviderResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an OAuth Provider object.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProvider"
]
}
},
"/msgVpns/{msgVpnName}/authenticationOauthProviders/{oauthProviderName}/clearStats": {
"put": {
"deprecated": true,
"description": "Clear the statistics for the OAuth Provider.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".\n\nDeprecated. authenticationOauthProviders replaced by authenticationOauthProfiles.",
"operationId": "doMsgVpnAuthenticationOauthProviderClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the OAuth Provider.",
"in": "path",
"name": "oauthProviderName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnAuthenticationOauthProviderClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the OAuth Provider.",
"tags": [
"all",
"msgVpn",
"authenticationOauthProvider"
]
}
},
"/msgVpns/{msgVpnName}/bridges": {
"get": {
"description": "Get a list of Bridge objects.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnBridges",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Bridge objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnBridgesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Bridge objects.",
"tags": [
"all",
"msgVpn",
"bridge"
]
}
},
"/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}": {
"get": {
"description": "Get a Bridge object.\n\nBridges can be used to link two Message VPNs so that messages published to one Message VPN that match the topic subscriptions set for the bridge are also delivered to the linked Message VPN.\n\n\nAttribute|Identifying\n:---|:---:\nbridgeName|x\nbridgeVirtualRouter|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnBridge",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Bridge.",
"in": "path",
"name": "bridgeName",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the Bridge.",
"in": "path",
"name": "bridgeVirtualRouter",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Bridge object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnBridgeResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Bridge object.",
"tags": [
"all",
"msgVpn",
"bridge"
]
}
},
"/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/clearEvent": {
"put": {
"description": "Clear an event for the Bridge so it can be generated anew.\n\n\nAttribute|Required\n:---|:---:\neventName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/mesh-manager\".",
"operationId": "doMsgVpnBridgeClearEvent",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Bridge.",
"in": "path",
"name": "bridgeName",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the Bridge.",
"in": "path",
"name": "bridgeVirtualRouter",
"required": true,
"type": "string"
},
{
"description": "The Clear Event action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnBridgeClearEvent"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear an event for the Bridge so it can be generated anew.",
"tags": [
"all",
"msgVpn",
"bridge"
]
}
},
"/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/clearStats": {
"put": {
"description": "Clear the statistics for the Bridge.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnBridgeClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Bridge.",
"in": "path",
"name": "bridgeName",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the Bridge.",
"in": "path",
"name": "bridgeVirtualRouter",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnBridgeClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Bridge.",
"tags": [
"all",
"msgVpn",
"bridge"
]
}
},
"/msgVpns/{msgVpnName}/bridges/{bridgeName},{bridgeVirtualRouter}/disconnect": {
"put": {
"description": "Disconnect the Bridge.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/mesh-manager\".",
"operationId": "doMsgVpnBridgeDisconnect",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Bridge.",
"in": "path",
"name": "bridgeName",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the Bridge.",
"in": "path",
"name": "bridgeVirtualRouter",
"required": true,
"type": "string"
},
{
"description": "The Disconnect action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnBridgeDisconnect"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Disconnect the Bridge.",
"tags": [
"all",
"msgVpn",
"bridge"
]
}
},
"/msgVpns/{msgVpnName}/clearMsgSpoolStats": {
"put": {
"description": "Clear the message spool statistics for the Message VPN.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClearMsgSpoolStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClearMsgSpoolStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the message spool statistics for the Message VPN.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}/clearReplicationStats": {
"put": {
"description": "Clear the replication statistics for the Message VPN.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClearReplicationStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClearReplicationStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the replication statistics for the Message VPN.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}/clearServiceStats": {
"put": {
"description": "Clear the service statistics for the Message VPN.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClearServiceStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClearServiceStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the service statistics for the Message VPN.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}/clearStats": {
"put": {
"description": "Clear the client statistics for the Message VPN.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the client statistics for the Message VPN.",
"tags": [
"all",
"msgVpn"
]
}
},
"/msgVpns/{msgVpnName}/clients": {
"get": {
"description": "Get a list of Client objects.\n\nApplications or devices that connect to message brokers to send and/or receive messages are represented as Clients.\n\n\nAttribute|Identifying\n:---|:---:\nclientName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnClients",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Client objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnClientsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Client objects.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}": {
"get": {
"description": "Get a Client object.\n\nApplications or devices that connect to message brokers to send and/or receive messages are represented as Clients.\n\n\nAttribute|Identifying\n:---|:---:\nclientName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnClient",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Client object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnClientResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Client object.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/clearEvent": {
"put": {
"description": "Clear an event for the Client so it can be generated anew.\n\n\nAttribute|Required\n:---|:---:\neventName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "doMsgVpnClientClearEvent",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"description": "The Clear Event action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClientClearEvent"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear an event for the Client so it can be generated anew.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/clearStats": {
"put": {
"description": "Clear the statistics for the Client.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClientClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClientClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Client.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/disconnect": {
"put": {
"description": "Disconnect the Client.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClientDisconnect",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"description": "The Disconnect action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClientDisconnect"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Disconnect the Client.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/transactedSessions": {
"get": {
"description": "Get a list of Client Transacted Session objects.\n\nTransacted Sessions enable clients to group multiple message send and/or receive operations together in single, atomic units known as local transactions.\n\n\nAttribute|Identifying\n:---|:---:\nclientName|x\nmsgVpnName|x\nsessionName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnClientTransactedSessions",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Client Transacted Session objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnClientTransactedSessionsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Client Transacted Session objects.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/transactedSessions/{sessionName}": {
"get": {
"description": "Get a Client Transacted Session object.\n\nTransacted Sessions enable clients to group multiple message send and/or receive operations together in single, atomic units known as local transactions.\n\n\nAttribute|Identifying\n:---|:---:\nclientName|x\nmsgVpnName|x\nsessionName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnClientTransactedSession",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"description": "The name of the Transacted Session.",
"in": "path",
"name": "sessionName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Client Transacted Session object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnClientTransactedSessionResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Client Transacted Session object.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/clients/{clientName}/transactedSessions/{sessionName}/delete": {
"put": {
"description": "Delete the Transacted Session.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnClientTransactedSessionDelete",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Client.",
"in": "path",
"name": "clientName",
"required": true,
"type": "string"
},
{
"description": "The name of the Transacted Session.",
"in": "path",
"name": "sessionName",
"required": true,
"type": "string"
},
{
"description": "The Delete action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnClientTransactedSessionDelete"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete the Transacted Session.",
"tags": [
"all",
"msgVpn",
"client"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches": {
"get": {
"description": "Get a list of Distributed Cache objects.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnDistributedCaches",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Distributed Cache objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCachesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Distributed Cache objects.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}": {
"get": {
"description": "Get a Distributed Cache object.\n\nA Distributed Cache is a collection of one or more Cache Clusters that belong to the same Message VPN. Each Cache Cluster in a Distributed Cache is configured to subscribe to a different set of topics. This effectively divides up the configured topic space, to provide scaling to very large topic spaces or very high cached message throughput.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnDistributedCache",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Distributed Cache object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Distributed Cache object.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters": {
"get": {
"description": "Get a list of Cache Cluster objects.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnDistributedCacheClusters",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Cache Cluster objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClustersResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Cache Cluster objects.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}": {
"get": {
"description": "Get a Cache Cluster object.\n\nA Cache Cluster is a collection of one or more Cache Instances that subscribe to exactly the same topics. Cache Instances are grouped together in a Cache Cluster for the purpose of fault tolerance and load balancing. As published messages are received, the message broker message bus sends these live data messages to the Cache Instances in the Cache Cluster. This enables client cache requests to be served by any of Cache Instances in the Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnDistributedCacheCluster",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Cache Cluster object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Cache Cluster object.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances": {
"get": {
"description": "Get a list of Cache Instance objects.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnDistributedCacheClusterInstances",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Cache Instance objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstancesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Cache Instance objects.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}": {
"get": {
"description": "Get a Cache Instance object.\n\nA Cache Instance is a single Cache process that belongs to a single Cache Cluster. A Cache Instance object provisioned on the broker is used to disseminate configuration information to the Cache process. Cache Instances listen for and cache live data messages that match the topic subscriptions configured for their parent Cache Cluster.\n\n\nAttribute|Identifying\n:---|:---:\ncacheName|x\nclusterName|x\ninstanceName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnDistributedCacheClusterInstance",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Cache Instance object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Cache Instance object.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/backupCachedMsgs": {
"put": {
"description": "Backup cached messages of the Cache Instance to disk.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceBackupCachedMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Backup Cached Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceBackupCachedMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Backup cached messages of the Cache Instance to disk.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/cancelBackupCachedMsgs": {
"put": {
"description": "Cancel the backup of cached messages from the Cache Instance.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceCancelBackupCachedMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Cancel Backup Cached Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceCancelBackupCachedMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Cancel the backup of cached messages from the Cache Instance.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/cancelRestoreCachedMsgs": {
"put": {
"description": "Cancel the restore of cached messages to the Cache Instance.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceCancelRestoreCachedMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Cancel Restore Cached Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceCancelRestoreCachedMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Cancel the restore of cached messages to the Cache Instance.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/clearEvent": {
"put": {
"description": "Clear an event for the Cache Instance so it can be generated anew.\n\n\nAttribute|Required\n:---|:---:\neventName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceClearEvent",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Clear Event action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceClearEvent"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear an event for the Cache Instance so it can be generated anew.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/clearStats": {
"put": {
"description": "Clear the statistics for the Cache Instance.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Cache Instance.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/deleteMsgs": {
"put": {
"description": "Delete messages covered by the given topic in the Cache Instance.\n\n\nAttribute|Required\n:---|:---:\ntopic|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceDeleteMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Delete Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceDeleteMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete messages covered by the given topic in the Cache Instance.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/restoreCachedMsgs": {
"put": {
"description": "Restore cached messages for the Cache Instance from disk.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceRestoreCachedMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Restore Cached Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceRestoreCachedMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Restore cached messages for the Cache Instance from disk.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/distributedCaches/{cacheName}/clusters/{clusterName}/instances/{instanceName}/start": {
"put": {
"description": "Start the Cache Instance.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnDistributedCacheClusterInstanceStart",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Distributed Cache.",
"in": "path",
"name": "cacheName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Cluster.",
"in": "path",
"name": "clusterName",
"required": true,
"type": "string"
},
{
"description": "The name of the Cache Instance.",
"in": "path",
"name": "instanceName",
"required": true,
"type": "string"
},
{
"description": "The Start Cache Instance action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnDistributedCacheClusterInstanceStart"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Start the Cache Instance.",
"tags": [
"all",
"msgVpn",
"distributedCache"
]
}
},
"/msgVpns/{msgVpnName}/kafkaReceivers": {
"get": {
"description": "Get a list of Kafka Receiver objects.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnKafkaReceivers",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Kafka Receiver objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnKafkaReceiversResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Kafka Receiver objects.",
"tags": [
"all",
"msgVpn",
"kafkaReceiver"
]
}
},
"/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}": {
"get": {
"description": "Get a Kafka Receiver object.\n\nA Kafka Receiver receives messages from a Kafka Cluster.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaReceiverName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnKafkaReceiver",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Kafka Receiver.",
"in": "path",
"name": "kafkaReceiverName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Kafka Receiver object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnKafkaReceiverResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Kafka Receiver object.",
"tags": [
"all",
"msgVpn",
"kafkaReceiver"
]
}
},
"/msgVpns/{msgVpnName}/kafkaReceivers/{kafkaReceiverName}/clearStats": {
"put": {
"description": "Clear the statistics for the Kafka Receiver.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnKafkaReceiverClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Kafka Receiver.",
"in": "path",
"name": "kafkaReceiverName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnKafkaReceiverClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Kafka Receiver.",
"tags": [
"all",
"msgVpn",
"kafkaReceiver"
]
}
},
"/msgVpns/{msgVpnName}/kafkaSenders": {
"get": {
"description": "Get a list of Kafka Sender objects.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnKafkaSenders",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Kafka Sender objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnKafkaSendersResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Kafka Sender objects.",
"tags": [
"all",
"msgVpn",
"kafkaSender"
]
}
},
"/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}": {
"get": {
"description": "Get a Kafka Sender object.\n\nA Kafka Sender sends messages to a Kafka Cluster.\n\n\nAttribute|Identifying\n:---|:---:\nkafkaSenderName|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnKafkaSender",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Kafka Sender.",
"in": "path",
"name": "kafkaSenderName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Kafka Sender object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnKafkaSenderResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Kafka Sender object.",
"tags": [
"all",
"msgVpn",
"kafkaSender"
]
}
},
"/msgVpns/{msgVpnName}/kafkaSenders/{kafkaSenderName}/clearStats": {
"put": {
"description": "Clear the statistics for the Kafka Sender.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnKafkaSenderClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Kafka Sender.",
"in": "path",
"name": "kafkaSenderName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnKafkaSenderClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Kafka Sender.",
"tags": [
"all",
"msgVpn",
"kafkaSender"
]
}
},
"/msgVpns/{msgVpnName}/mqttSessions": {
"get": {
"description": "Get a list of MQTT Session objects.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnMqttSessions",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of MQTT Session objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnMqttSessionsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of MQTT Session objects.",
"tags": [
"all",
"msgVpn",
"mqttSession"
]
}
},
"/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}": {
"get": {
"description": "Get an MQTT Session object.\n\nAn MQTT Session object is a virtual representation of an MQTT client connection. An MQTT session holds the state of an MQTT client (that is, it is used to contain a client's QoS 0 and QoS 1 subscription sets and any undelivered QoS 1 messages).\n\n\nAttribute|Identifying\n:---|:---:\nmqttSessionClientId|x\nmqttSessionVirtualRouter|x\nmsgVpnName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnMqttSession",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.",
"in": "path",
"name": "mqttSessionClientId",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the MQTT Session.",
"in": "path",
"name": "mqttSessionVirtualRouter",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The MQTT Session object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnMqttSessionResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an MQTT Session object.",
"tags": [
"all",
"msgVpn",
"mqttSession"
]
}
},
"/msgVpns/{msgVpnName}/mqttSessions/{mqttSessionClientId},{mqttSessionVirtualRouter}/clearStats": {
"put": {
"description": "Clear the statistics for the MQTT Session.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnMqttSessionClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The Client ID of the MQTT Session, which corresponds to the ClientId provided in the MQTT CONNECT packet.",
"in": "path",
"name": "mqttSessionClientId",
"required": true,
"type": "string"
},
{
"description": "The virtual router of the MQTT Session.",
"in": "path",
"name": "mqttSessionVirtualRouter",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnMqttSessionClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the MQTT Session.",
"tags": [
"all",
"msgVpn",
"mqttSession"
]
}
},
"/msgVpns/{msgVpnName}/queues": {
"get": {
"description": "Get a list of Queue objects.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnQueues",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Queue objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnQueuesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Queue objects.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}": {
"get": {
"description": "Get a Queue object.\n\nA Queue acts as both a destination that clients can publish messages to, and as an endpoint that clients can bind consumers to and consume messages from.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nqueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnQueue",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Queue object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnQueueResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Queue object.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/cancelReplay": {
"put": {
"description": "Cancel the replay of messages to the Queue.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueCancelReplay",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Cancel Replay action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueCancelReplay"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Cancel the replay of messages to the Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/clearStats": {
"put": {
"description": "Clear the statistics for the Queue.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/copyMsgFromQueue": {
"put": {
"description": "Copy a message from another Queue to this Queue.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceQueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueCopyMsgFromQueue",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Queue action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueCopyMsgFromQueue"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from another Queue to this Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/copyMsgFromReplayLog": {
"put": {
"description": "Copy a message from a Replay Log to this Queue.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceReplayLogName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueCopyMsgFromReplayLog",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Replay Log action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueCopyMsgFromReplayLog"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from a Replay Log to this Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/copyMsgFromTopicEndpoint": {
"put": {
"description": "Copy a message from a Topic Endpoint to this Queue.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceTopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueCopyMsgFromTopicEndpoint",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Topic Endpoint action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueCopyMsgFromTopicEndpoint"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from a Topic Endpoint to this Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/deleteMsgs": {
"put": {
"description": "Delete all spooled messages from the Queue.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueDeleteMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Delete All Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueDeleteMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete all spooled messages from the Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/msgs": {
"get": {
"description": "Get a list of Queue Message objects.\n\nA Queue Message is a packet of information sent from producers to consumers using the Queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgId|x\nmsgVpnName|x\nqueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnQueueMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Queue Message objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnQueueMsgsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Queue Message objects.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/msgs/{msgId}": {
"get": {
"description": "Get a Queue Message object.\n\nA Queue Message is a packet of information sent from producers to consumers using the Queue.\n\n\nAttribute|Identifying\n:---|:---:\nmsgId|x\nmsgVpnName|x\nqueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnQueueMsg",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Message.",
"in": "path",
"name": "msgId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Queue Message object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnQueueMsgResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Queue Message object.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/msgs/{msgId}/delete": {
"put": {
"description": "Delete the Message from the Queue.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueMsgDelete",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Message.",
"in": "path",
"name": "msgId",
"required": true,
"type": "string"
},
{
"description": "The Delete action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueMsgDelete"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete the Message from the Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/queues/{queueName}/startReplay": {
"put": {
"description": "Start the replay of messages to the Queue.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnQueueStartReplay",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Queue.",
"in": "path",
"name": "queueName",
"required": true,
"type": "string"
},
{
"description": "The Start Replay action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnQueueStartReplay"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Start the replay of messages to the Queue.",
"tags": [
"all",
"msgVpn",
"queue"
]
}
},
"/msgVpns/{msgVpnName}/replayLogs": {
"get": {
"description": "Get a list of Replay Log objects.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnReplayLogs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Replay Log objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnReplayLogsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Replay Log objects.",
"tags": [
"all",
"msgVpn",
"replayLog"
]
}
},
"/msgVpns/{msgVpnName}/replayLogs/{replayLogName}": {
"get": {
"description": "Get a Replay Log object.\n\nWhen the Message Replay feature is enabled, message brokers store persistent messages in a Replay Log. These messages are kept until the log is full, after which the oldest messages are removed to free up space for new messages.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nreplayLogName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnReplayLog",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Replay Log.",
"in": "path",
"name": "replayLogName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Replay Log object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnReplayLogResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Replay Log object.",
"tags": [
"all",
"msgVpn",
"replayLog"
]
}
},
"/msgVpns/{msgVpnName}/replayLogs/{replayLogName}/trimLoggedMsgs": {
"put": {
"description": "Trim (delete) messages from the Replay Log.\n\n\nAttribute|Required\n:---|:---:\nolderThanTime|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnReplayLogTrimLoggedMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Replay Log.",
"in": "path",
"name": "replayLogName",
"required": true,
"type": "string"
},
{
"description": "The Trim Logged Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnReplayLogTrimLoggedMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Trim (delete) messages from the Replay Log.",
"tags": [
"all",
"msgVpn",
"replayLog"
]
}
},
"/msgVpns/{msgVpnName}/restDeliveryPoints": {
"get": {
"description": "Get a list of REST Delivery Point objects.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnRestDeliveryPoints",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of REST Delivery Point objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of REST Delivery Point objects.",
"tags": [
"all",
"msgVpn",
"restDeliveryPoint"
]
}
},
"/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}": {
"get": {
"description": "Get a REST Delivery Point object.\n\nA REST Delivery Point manages delivery of messages from queues to a named list of REST Consumers.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestDeliveryPointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnRestDeliveryPoint",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Delivery Point.",
"in": "path",
"name": "restDeliveryPointName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The REST Delivery Point object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a REST Delivery Point object.",
"tags": [
"all",
"msgVpn",
"restDeliveryPoint"
]
}
},
"/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers": {
"get": {
"description": "Get a list of REST Consumer objects.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestConsumerName|x\nrestDeliveryPointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnRestDeliveryPointRestConsumers",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Delivery Point.",
"in": "path",
"name": "restDeliveryPointName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of REST Consumer objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumersResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of REST Consumer objects.",
"tags": [
"all",
"msgVpn",
"restDeliveryPoint"
]
}
},
"/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}": {
"get": {
"description": "Get a REST Consumer object.\n\nREST Consumer objects establish HTTP connectivity to REST consumer applications who wish to receive messages from a broker.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nrestConsumerName|x\nrestDeliveryPointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnRestDeliveryPointRestConsumer",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Delivery Point.",
"in": "path",
"name": "restDeliveryPointName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Consumer.",
"in": "path",
"name": "restConsumerName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The REST Consumer object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a REST Consumer object.",
"tags": [
"all",
"msgVpn",
"restDeliveryPoint"
]
}
},
"/msgVpns/{msgVpnName}/restDeliveryPoints/{restDeliveryPointName}/restConsumers/{restConsumerName}/clearStats": {
"put": {
"description": "Clear the statistics for the REST Consumer.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnRestDeliveryPointRestConsumerClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Delivery Point.",
"in": "path",
"name": "restDeliveryPointName",
"required": true,
"type": "string"
},
{
"description": "The name of the REST Consumer.",
"in": "path",
"name": "restConsumerName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnRestDeliveryPointRestConsumerClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the REST Consumer.",
"tags": [
"all",
"msgVpn",
"restDeliveryPoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints": {
"get": {
"description": "Get a list of Topic Endpoint objects.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnTopicEndpoints",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Topic Endpoint objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Topic Endpoint objects.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}": {
"get": {
"description": "Get a Topic Endpoint object.\n\nA Topic Endpoint attracts messages published to a topic for which the Topic Endpoint has a matching topic subscription. The topic subscription for the Topic Endpoint is specified in the client request to bind a Flow to that Topic Endpoint. Queues are significantly more flexible than Topic Endpoints and are the recommended approach for most applications. The use of Topic Endpoints should be restricted to JMS applications.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnTopicEndpoint",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Topic Endpoint object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Topic Endpoint object.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/cancelReplay": {
"put": {
"description": "Cancel the replay of messages to the Topic Endpoint.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointCancelReplay",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Cancel Replay action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointCancelReplay"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Cancel the replay of messages to the Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/clearStats": {
"put": {
"description": "Clear the statistics for the Topic Endpoint.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointClearStats",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/copyMsgFromQueue": {
"put": {
"description": "Copy a message from a Queue to this Topic Endpoint.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceQueueName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointCopyMsgFromQueue",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Queue action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointCopyMsgFromQueue"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from a Queue to this Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/copyMsgFromReplayLog": {
"put": {
"description": "Copy a message from a Replay Log to this Topic Endpoint.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceReplayLogName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointCopyMsgFromReplayLog",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Replay Log action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointCopyMsgFromReplayLog"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from a Replay Log to this Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/copyMsgFromTopicEndpoint": {
"put": {
"description": "Copy a message from another Topic Endpoint to this Topic Endpoint.\n\n\nAttribute|Required\n:---|:---:\nreplicationGroupMsgId|x\nsourceTopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointCopyMsgFromTopicEndpoint",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Copy Message From Topic Endpoint action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointCopyMsgFromTopicEndpoint"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Copy a message from another Topic Endpoint to this Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/deleteMsgs": {
"put": {
"description": "Delete all spooled messages from the Topic Endpoint.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointDeleteMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Delete All Messages action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointDeleteMsgs"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete all spooled messages from the Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/msgs": {
"get": {
"description": "Get a list of Topic Endpoint Message objects.\n\nA Topic Endpoint Message is a packet of information sent from producers to consumers using the Topic Endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgId|x\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnTopicEndpointMsgs",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Topic Endpoint Message objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsgsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Topic Endpoint Message objects.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/msgs/{msgId}": {
"get": {
"description": "Get a Topic Endpoint Message object.\n\nA Topic Endpoint Message is a packet of information sent from producers to consumers using the Topic Endpoint.\n\n\nAttribute|Identifying\n:---|:---:\nmsgId|x\nmsgVpnName|x\ntopicEndpointName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnTopicEndpointMsg",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Message.",
"in": "path",
"name": "msgId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Topic Endpoint Message object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsgResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Topic Endpoint Message object.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/msgs/{msgId}/delete": {
"put": {
"description": "Delete the Message from the Topic Endpoint.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointMsgDelete",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Message.",
"in": "path",
"name": "msgId",
"required": true,
"type": "string"
},
{
"description": "The Delete action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointMsgDelete"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete the Message from the Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/topicEndpoints/{topicEndpointName}/startReplay": {
"put": {
"description": "Start the replay of messages to the Topic Endpoint.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTopicEndpointStartReplay",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The name of the Topic Endpoint.",
"in": "path",
"name": "topicEndpointName",
"required": true,
"type": "string"
},
{
"description": "The Start Replay action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTopicEndpointStartReplay"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Start the replay of messages to the Topic Endpoint.",
"tags": [
"all",
"msgVpn",
"topicEndpoint"
]
}
},
"/msgVpns/{msgVpnName}/transactions": {
"get": {
"description": "Get a list of Replicated Local Transaction or XA Transaction objects.\n\nTransactions can be used to group a set of Guaranteed messages to be published or consumed or both as an atomic unit of work.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nxid|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getMsgVpnTransactions",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of Replicated Local Transaction or XA Transaction objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTransactionsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of Replicated Local Transaction or XA Transaction objects.",
"tags": [
"all",
"msgVpn",
"transaction"
]
}
},
"/msgVpns/{msgVpnName}/transactions/{xid}": {
"get": {
"description": "Get a Replicated Local Transaction or XA Transaction object.\n\nTransactions can be used to group a set of Guaranteed messages to be published or consumed or both as an atomic unit of work.\n\n\nAttribute|Identifying\n:---|:---:\nmsgVpnName|x\nxid|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-only\".",
"operationId": "getMsgVpnTransaction",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Transaction.",
"in": "path",
"name": "xid",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The Replicated Local Transaction or XA Transaction object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/MsgVpnTransactionResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a Replicated Local Transaction or XA Transaction object.",
"tags": [
"all",
"msgVpn",
"transaction"
]
}
},
"/msgVpns/{msgVpnName}/transactions/{xid}/commit": {
"put": {
"description": "Commit the Transaction.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTransactionCommit",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Transaction.",
"in": "path",
"name": "xid",
"required": true,
"type": "string"
},
{
"description": "The Commit action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTransactionCommit"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Commit the Transaction.",
"tags": [
"all",
"msgVpn",
"transaction"
]
}
},
"/msgVpns/{msgVpnName}/transactions/{xid}/delete": {
"put": {
"description": "Delete the Transaction.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTransactionDelete",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Transaction.",
"in": "path",
"name": "xid",
"required": true,
"type": "string"
},
{
"description": "The Delete action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTransactionDelete"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete the Transaction.",
"tags": [
"all",
"msgVpn",
"transaction"
]
}
},
"/msgVpns/{msgVpnName}/transactions/{xid}/rollback": {
"put": {
"description": "Rollback the Transaction.\n\n\n\nThe minimum access scope/level required to perform this operation is \"vpn/read-write\".",
"operationId": "doMsgVpnTransactionRollback",
"parameters": [
{
"description": "The name of the Message VPN.",
"in": "path",
"name": "msgVpnName",
"required": true,
"type": "string"
},
{
"description": "The identifier (ID) of the Transaction.",
"in": "path",
"name": "xid",
"required": true,
"type": "string"
},
{
"description": "The Rollback action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/MsgVpnTransactionRollback"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Rollback the Transaction.",
"tags": [
"all",
"msgVpn",
"transaction"
]
}
},
"/oauthProfiles": {
"get": {
"description": "Get a list of OAuth Profile objects.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying\n:---|:---:\noauthProfileName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getOauthProfiles",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of OAuth Profile objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/OauthProfilesResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of OAuth Profile objects.",
"tags": [
"all",
"oauthProfile"
]
}
},
"/oauthProfiles/{oauthProfileName}": {
"get": {
"description": "Get an OAuth Profile object.\n\nOAuth profiles specify how to securely authenticate to an OAuth provider.\n\n\nAttribute|Identifying\n:---|:---:\noauthProfileName|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".",
"operationId": "getOauthProfile",
"parameters": [
{
"description": "The name of the OAuth profile.",
"in": "path",
"name": "oauthProfileName",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The OAuth Profile object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/OauthProfileResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get an OAuth Profile object.",
"tags": [
"all",
"oauthProfile"
]
}
},
"/oauthProfiles/{oauthProfileName}/clearStats": {
"put": {
"description": "Clear the statistics for the OAuth Profile.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-write\".",
"operationId": "doOauthProfileClearStats",
"parameters": [
{
"description": "The name of the OAuth profile.",
"in": "path",
"name": "oauthProfileName",
"required": true,
"type": "string"
},
{
"description": "The Clear Stats action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/OauthProfileClearStats"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Clear the statistics for the OAuth Profile.",
"tags": [
"all",
"oauthProfile"
]
}
},
"/sessions": {
"get": {
"description": "Get a list of SEMP Session objects.\n\nAdministrative sessions for configuration and monitoring.\n\n\nAttribute|Identifying\n:---|:---:\nsessionId|x\nsessionUsername|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".\n\nThe maximum number of objects that can be returned in a single page is 100.",
"operationId": "getSessions",
"parameters": [
{
"$ref": "#/parameters/countQuery"
},
{
"$ref": "#/parameters/cursorQuery"
},
{
"$ref": "#/parameters/whereQuery"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The list of SEMP Session objects' attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/SessionsResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a list of SEMP Session objects.",
"tags": [
"all",
"session"
]
}
},
"/sessions/{sessionUsername},{sessionId}": {
"get": {
"description": "Get a SEMP Session object.\n\nAdministrative sessions for configuration and monitoring.\n\n\nAttribute|Identifying\n:---|:---:\nsessionId|x\nsessionUsername|x\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/read-only\".",
"operationId": "getSession",
"parameters": [
{
"description": "The username used for authorization.",
"in": "path",
"name": "sessionUsername",
"required": true,
"type": "string"
},
{
"description": "The unique identifier for the session.",
"in": "path",
"name": "sessionId",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/selectQuery"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The SEMP Session object's attributes, and the request metadata.",
"schema": {
"$ref": "#/definitions/SessionResponse"
}
},
"default": {
"description": "The error response.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Get a SEMP Session object.",
"tags": [
"all",
"session"
]
}
},
"/sessions/{sessionUsername},{sessionId}/delete": {
"put": {
"description": "Delete the SEMP session.\n\n\n\nThe minimum access scope/level required to perform this operation is \"global/admin\".",
"operationId": "doSessionDelete",
"parameters": [
{
"description": "The username used for authorization.",
"in": "path",
"name": "sessionUsername",
"required": true,
"type": "string"
},
{
"description": "The unique identifier for the session.",
"in": "path",
"name": "sessionId",
"required": true,
"type": "string"
},
{
"description": "The Delete action's attributes.",
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SessionDelete"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "The action was successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
},
"default": {
"description": "The action was not successfully performed.",
"schema": {
"$ref": "#/definitions/SempMetaOnlyResponse"
}
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Delete the SEMP session.",
"tags": [
"all",
"session"
]
}
}
},
"produces": [
"application/json"
],
"schemes": [
"http",
"https"
],
"securityDefinitions": {
"basicAuth": {
"description": "basic authentication",
"type": "basic"
}
},
"swagger": "2.0",
"tags": []
}