Update the configuration of an existing client profile. You can provide any combination of supported fields. If a field is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/eventBrokerServices/{serviceId}/clientProfiles/{name}": {
"patch": {
"tags": [
"Client Profiles"
],
"summary": "Update a client profile",
"description": "Update the configuration of an existing client profile. You can provide any combination of supported fields. If a field is not provided, then it will not be updated.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or service_requests:post:client_profile ]",
"operationId": "updateClientProfile",
"parameters": [
{
"name": "serviceId",
"in": "path",
"description": "The unique identifier of the event broker service.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "name",
"in": "path",
"description": "The name of the client profile.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "The configuration to update for the client profile.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientProfileRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponse"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "A JSON parse error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "You do not have permissions to perform this operation.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Could not find the client profile with name, some_name.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"409": {
"description": "Conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ClientProfileRequest": {
"type": "object",
"properties": {
"name": {
"maxLength": 32,
"minLength": 1,
"pattern": "[a-zA-Z0-9-_]*",
"type": "string"
},
"allowGuaranteedMsgSendEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to publish guaranteed messages. The valid values are 'true' (allowed) or 'false' (not allowed) . The default is 'false'."
},
"allowGuaranteedMsgReceiveEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to bind to topic endpoints or queues to receive guaranteed messages. The valid values are 'true' (allowed) or 'false' (not allowed). The default is 'false'."
},
"compressionEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to transfer data using compression. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'true'."
},
"replicationAllowClientConnectWhenStandbyEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to remain connected to the Message VPN when its replication state is Standby. This situation may occur when the Message VPN Replication state of the event broker service changes from Active to Standby. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."
},
"allowTransactedSessionsEnabled": {
"type": "boolean",
"description": "Indicates whether client applications client applications assigned to the client profile are allowed to establish transacted sessions or XA sessions. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."
},
"allowBridgeConnectionsEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to establish Dynamic Messaging Routing (DMR) links (or bridge links) from the current Message VPN to another Message VPN in a separate event broker service. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."
},
"allowGuaranteedEndpointCreateEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to create queues or topic endpoints. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."
},
"allowSharedSubscriptionsEnabled": {
"type": "boolean",
"description": "Indicates whether clients assigned to the client profile are allowed to use shared subscriptions. The valid values are 'true' (allowed) and 'false' (not allowed). The default is 'false'."
},
"apiQueueManagementCopyFromOnCreateName": {
"maxLength": 200,
"minLength": 0,
"type": "string",
"description": "Removal Date: 2024-05-26
Reason: Replaced by apiQueueManagementCopyFromOnCreateTemplateName
The name of a queue template to copy settings from when a new queue iscreated by the client using the client profile. If the specified queue template does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiQueueManagementCopyFromOnCreateTemplateName.
", "deprecated": true }, "apiQueueManagementCopyFromOnCreateTemplateName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The name of a queue template to copy settings from when a new queue is created by the client using the client profile. If the specified queue template does not exist, creation fails. " }, "apiTopicEndpointManagementCopyFromOnCreateName": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Removal Date: 2024-05-26
Reason: Replaced by apiTopicEndpointManagementCopyFromOnCreateTemplateName
The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails. Deprecated since 2.14. This attribute has been replaced with apiTopicEndpointManagementCopyFromOnCreateTemplateName.
", "deprecated": true }, "apiTopicEndpointManagementCopyFromOnCreateTemplateName": { "maxLength": 255, "minLength": 0, "type": "string", "description": "The name of a topic endpoint to copy settings from when a new topic endpoint is created by the client using the client profile. If the specified topic endpoint does not exist, creation fails." }, "serviceMinKeepaliveTimeout": { "type": "integer", "description": "The minimum period of time (in seconds) that the event broker service will tolerate inactivity on the client connection. This keepalive value is also enforced for MQTT and SMF (Solace Message Format) connections. The keepalive timeout value is calculated based on the client provided timeout interval (3 x the keepalive interval for SMF, 1.5 x the keepalive interval for MQTT). The default is 30 and valid ranges are 3–3600.", "format": "int32" }, "serviceSmfMinKeepaliveEnabled": { "type": "boolean", "description": "Indicates whether clients using the client profile have the minimum keep-alive timeout enabled for SMF (Solace Message Format) connections. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'." }, "serviceWebInactiveTimeout": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The number of seconds a Web client has to send a request before its session times out and be terminated for being inactive. The default value is 30 seconds.", "format": "int32" }, "serviceWebMaxPayload": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum transport payload size (in bytes) before fragmentation occurs for clients using the client profile. The size of the header is not included.\n\nSolace Message Format (SMF) messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. The value range is 300 to 10000000, in bytes. The default is 1000000 bytes.\n\nSMF messages that are sent to a consuming Web client are contained within a Web transport message that the event broker sends in its HTTP response to that client. Each Web transport message that is sent can contain multiple SMF messages or partial SMF messages.\n\nThe maximum Web payload value sets the maximum number of bytes allowed in a single Web transport message (not including the header). This value determines the number of SMF messages that can be sent in a single HTTP response and the size of the Web transport message sent in the HTTP response. Note that large SMF messages can be fragmented across Web transport messages to respect the value set for the maximum possible Web payload.", "format": "int32" }, "maxConnectionCountPerClientUsername": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.", "format": "int32" }, "serviceSmfMaxConnectionCountPerClientUsername": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum permitted number of simultaneous Solace Message Format (SMF) client connections to the event broker that can be made using the same client username account. The default is the maximum value supported by the platform.", "format": "int32" }, "serviceWebMaxConnectionCountPerClientUsername": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum permitted number of simultaneous Web transport client connections to the event broker service that can be made using the same client username account. The default is the maximum value supported by the platform.", "format": "int32" }, "maxEndpointCountPerClientUsername": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of durable and non-durable queues and topic endpoints that can be owned by the clients using the same client username within a client profile. The default is 1000.", "format": "int32" }, "maxEgressFlowCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of egress flows (that is, Guaranteed Message client receive flows or consumer flows) that can be created by a single client associated with this client profile. The default is 1000.", "format": "int32" }, "maxIngressFlowCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of ingress flows (that is, Guaranteed Message client publish flows) that can be created by a single client associated with this client profile. The default is 1000.", "format": "int32" }, "maxSubscriptionCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of subscriptions for a single client in the client profile. When you set this option, consider the total maximum number of permitted topic subscriptions and the total maximum number of client connections for the type of event broker that is used. That is, to ensure reliable system performance, you must find the right balance for your network, while staying within the system limits mentioned. The balance is generally between allowing the creation of many client applications and allowing each client to add a large number of topic subscriptions. The default varies by platform.", "format": "int32" }, "maxTransactedSessionCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of simultaneous transacted sessions and/or XA sessions allowed for a single client associated with the client profile. The default is 10.", "format": "int32" }, "maxTransactionCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The total maximum number of simultaneous transactions (both local transactions and transactions within the XA transaction branches) allowed for a single client associated with the client profile. The default varies by platform.", "format": "int32" }, "queueGuaranteed1MaxDepth": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The egress queue maximum depth for Guaranteed Messages that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.", "format": "int32" }, "queueGuaranteed1MinMsgBurst": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The minimum number of messages that must be on the Guaranteed Message queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 255. The value of 255 is recommended for memory usage optimized configurations, such as message applications; a value of 66000 is for WAN optimized configurations.", "format": "int32" }, "queueDirect1MaxDepth": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The egress queue maximum depth for Direct Messages 1 [Class of Service (COS) 1] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.", "format": "int32" }, "queueDirect1MinMsgBurst": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.", "format": "int32" }, "queueDirect2MaxDepth": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The egress queue maximum depth for Direct Messages 2 (COS 2) that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.", "format": "int32" }, "queueDirect2MinMsgBurst": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The minimum number of messages that must be on the Direct 2 (COS 2) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.", "format": "int32" }, "queueDirect3MaxDepth": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The egress queue maximum depth for Direct Messages 3 [Class of Service (COS) 3] that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.", "format": "int32" }, "queueDirect3MinMsgBurst": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The minimum number of messages that must be on the Direct 3 (COS 3) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.", "format": "int32" }, "queueControl1MaxDepth": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The egress queue maximum depth for Control 1 that represents the number of work units for the client priority queues. The valid range is 2 to 262144. The default is 20000.", "format": "int32" }, "queueControl1MinMsgBurst": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The minimum number of messages that must be on the Direct 1 (COS 1) queue before the queue’s depth is checked against the maximum depth setting (thereby allowing the queue to absorb a burst of large messages that exceeds the number of allowed work units). A valid range is 0 to 262144 with the default of 4.", "format": "int32" }, "tcpCongestionWindowSize": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The TCP initial congestion window size is the number of segments that TCP sends before waiting for an acknowledgment from the peer. The TCP initial congestion window size is used when starting up a TCP connection or on recovery from idle (that is, no traffic). Larger values of the initial window allows a connection to come up to speed more quickly. For further details, refer to RFC 2581.\nChanging the TCP initial congestion window size from its default of 2 results in non-compliance with RFC 2581. Further, if this setting is set to a value too high, it may cause congestion in the network. Contact support before you attempt to change this TCP parameter.", "format": "int32" }, "tcpKeepaliveCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of keepalive probes (from 2 to 5 ) that TCP should send before dropping the connection. The default is 5.", "format": "int32" }, "tcpKeepaliveIdleTime": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The time (from 3 to 120 seconds) a connection must remain idle before TCP begins sending keepalive probes. The default is 3.", "format": "int32" }, "tcpKeepaliveInterval": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The time (from 1 to 30 seconds) to set as the interval between individual keepalive probes. The default is 1.", "format": "int32" }, "tcpMaxSegmentSize": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The TCP maximum segment size (MSS) used for client to the event broker service. The default is 1460.", "format": "int32" }, "tcpMaxWindowSize": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The TCP window size between the event broker service and the client.\nIf the maximum window size is set to less than the bandwidth-delay product, then the TCP connection operates below its maximum potential throughput. If the maximum window is set to less than about twice the bandwidth-delay product, then occasional packet loss causes the TCP connection to operate below its maximum potential throughput as it handles the missing acknowledgments and retransmissions. The default is 256.\n\nAlternately, if the TCP maximum window size is set too large, in the presence of a high offered load, TCP gradually increases its congestion window size until either the congestion window size reaches the maximum window size, or packet loss occurs in the network.\n\nInitially, when the TCP congestion window size is small, the physical bandwidth-delay of the network acts as a memory buffer for packets in flight. But as the congestion window crosses the bandwidth-delay product, the buffering of in-flight packets moves to queues in event broker services and other equipment throughout the network. As the TCP congestion window continues to increase in size, these various equipment queues overflow, causing packet loss and TCP backoff.", "format": "int32" }, "elidingDelay": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The amount of time to delay the delivery of messages to a client after the initial message has been delivered. You can specify a value from 0-6000 milliseconds. The default is 0.", "format": "int32" }, "elidingEnabled": { "type": "boolean", "description": "Indicates whether clients assigned to the client profile are allowed to use eliding. Eliding allows clients to define a custom per-topic rate for client applications so they can effectively consume relevant messages, rather than queuing up outdated messages. For example, when eliding is configured, clients could receive direct messages for their topic subscriptions at a rate of at most five per second, per topic–even though the source is publishing updates at a much higher rate. The valid values are 'true' (enabled) and 'false' (not enabled). The default is 'false'." }, "elidingMaxTopicCount": { "maximum": 9223372036854776000, "minimum": 0, "type": "integer", "description": "The maximum number of topics the event broker service that can track for performing the eliding function on each client connection. You can specify a value from 1-320000. The default is 256.", "format": "int32" }, "rejectMsgToSenderOnNoSubscriptionMatchEnabled": { "type": "boolean", "description": "Indicates whether clients assigned the client profile are allowed to return NACKs (negative acknowledgements) for guaranteed messages that do not have a that do not have a matching guaranteed message subscription. The value values are 'true' (allowed) and 'false' (not allowed). The default is 'false'." }, "tlsAllowDowngradeToPlainTextEnabled": { "type": "boolean", "description": "Indicates whether clients assigned the client profile are allowed to use TLS/SSL encryption to protect the clients' credentials. This setting doesn't encrypt the data that is transmitted after the clients are authenticated and authorized. This also allows connecting client applications to request to downgrade of their TLS/SSL connections to the Message VPN to a plain-text connection, and if that Message VPN allows TLS/SSL connection downgrades, after the clientsʼ login handshake are finished, their connections are downgraded. This means that the clientsʼ authentication data is still encrypted, but the subsequent application data that is transmitted is sent as non-encrypted plain-text. The valid values are 'true (allowed) or 'false (not allowed). The default is 'true'." }, "eventClientProvisionedEndpointSpoolUsageThreshold": { "$ref": "#/components/schemas/ProvisionedEndpointSpoolUsageAlertThresholds" }, "id": { "type": "string" }, "type": { "type": "string" } }, "description": "The client profile configured on the event broker service." }, "ErrorResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "A user-friendly message that describes the error.", "example": "An error occurred." }, "errorId": { "type": "string", "description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.", "example": "123e4567-e89b-12d3-a456-426655440000" }, "meta": { "type": "object", "additionalProperties": { "type": "object", "description": "The metadata about the error. This provides additional information about the error that occurred.", "example": "'object': { 'field': 'description' }" }, "description": "The metadata about the error. This provides additional information about the error that occurred.", "example": "'object': { 'field': 'description' }" }, "validationDetails": { "type": "object", "additionalProperties": { "type": "array", "description": "When applicable, these are the details of issues with the fields provided for the REST call.", "example": "'name': ['Not unique']", "items": { "type": "string", "description": "When applicable, these are the details of issues with the fields provided for the REST call.", "example": "'name': ['Not unique']" } }, "description": "When applicable, these are the details of issues with the fields provided for the REST call.", "example": "'name': ['Not unique']" } } }, "Link": { "type": "object", "properties": { "href": { "type": "string", "description": "The location of the related resource, relative to the API root.", "readOnly": true, "example": "/api/v2/missionControl/eventBrokerServices/abc123/deploymentInstructions" } }, "description": "A link to a related resource.", "readOnly": true }, "Operation": { "type": "object", "properties": { "id": { "type": "string", "description": "Operations requiring time to complete provide an operation identifier so you can query their progress." }, "type": { "type": "string", "description": "The type of object for informational purposes.", "readOnly": true, "example": "operation" }, "operationType": { "$ref": "#/components/schemas/jobOperationTypes" }, "createdBy": { "type": "string", "description": "The unique identifier representing the user who created the operation." }, "createdTime": { "type": "string", "description": "The time the operation was created, in ISO 8601 date/time format.", "example": "2022-03-14T15:01:34.000Z" }, "completedTime": { "type": "string", "description": "The completion time, whether it was successful or failed, in ISO 8601 date/time format.", "example": "2022-03-14T15:01:34.000Z" }, "resourceId": { "type": "string", "description": "The resource ID that the operation belongs to.", "readOnly": true, "example": "abcd1234" }, "resourceType": { "type": "string", "description": "The resource type that the operation belongs to.", "readOnly": true, "example": "service" }, "progressLogs": { "type": "array", "description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below.", "items": { "$ref": "#/components/schemas/OperationProgressLog" } }, "status": { "type": "string", "description": "The status of the operation.", "readOnly": true, "example": "PENDING", "enum": [ "PENDING", "INPROGRESS", "SUCCEEDED", "FAILED" ] }, "error": { "$ref": "#/components/schemas/OperationError" }, "_links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Link" }, "description": "Links to resources related to this operation, keyed by link relation. Present only for operations that have related resources to point at.", "readOnly": true } } }, "OperationError": { "type": "object", "properties": { "message": { "type": "string", "description": "A user-friendly message describing the reason for the error or what went wrong." }, "errorId": { "type": "string", "description": "A universally unique identifier (UUID) is useful for debugging. You can provide this code as part of the information you send to our support team." } } }, "OperationProgressLog": { "type": "object", "properties": { "step": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" }, "stepId": { "type": "string" }, "status": { "type": "string" } }, "description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below." }, "OperationResponse": { "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Operation" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ProvisionedEndpointSpoolUsageAlertThresholds": { "type": "object", "properties": { "setPercent": { "type": "integer", "description": "The clear threshold value for the message spool usage (as a percentage).", "format": "int32" }, "clearPercent": { "type": "integer", "description": "The raise threshold value for the message spool usage (as a percentage).", "format": "int32" } }, "description": "The clear ('clearPercent') and raise ('setPercent') threshold values that determine when to generate events for the percentage amount of the message spool used by all endpoints provisioned by clients for the given client profile." }, "jobOperationTypes": { "type": "string", "description": "The type of operation against the resource.", "enum": [ "createService", "cloneService", "deleteService", "createClientProfile", "updateClientProfile", "deleteClientProfile", "createDnsName", "moveDnsName", "deleteDnsName", "serviceRequest", "infrastructureRequest", "datacenterRequest", "uploadCertificate", "installCertificate", "deleteCertificate", "haSwitchover", "rotateReplicationPSK", "serviceScaleUp", "serviceUpgrade", "createConnectionEndpoint", "updateConnectionEndpoint", "updateMateLinkEncryption", "deleteConnectionEndpoint", "createLdapManagementAccess", "updateLdapManagementAccess", "deleteLdapManagementAccess", "createLdapProfile", "updateLdapProfile", "deleteLdapProfile", "enableDmrCluster", "disableDmrCluster", "resetBrokerPasswords" ] } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } } ```