Public
Documentation Settings
Solace PubSub+ Cloud Client Profiles
Double Column
cURL - cURL
Solace Blogs - Solace Cloud Client Profile Management
Introduction
POST
Create a Client Profile
GET
GET Service Request
GET
GET Client Profile
POST
Update a Client Profile
POST
Delete a Client Profile

Solace Blogs - Solace Cloud Client Profile Management

This collection shows you how to create and manage service client profiles in Solace PubSub+ Cloud.

POSTCreate a Client Profile

https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/requests/clientProfileRequests

This creates a client profile on the service

The operation paramenter in the body specifies that this is a create operation.

The clientProfile parameter defines the properties of the client profile being created.

HEADERS
Content-Type

application/json

Authorization

Bearer {paste-your-token-here}

Bodyraw 
{
  "operation": "create",
  "clientProfile": {
    "clientProfileName": "myClientProfile",
    "allowGuaranteedMsgSendEnabled": "true",
    "allowGuaranteedMsgReceiveEnabled": "true",
    "allowTransactedSessionsEnabled": "true",
    "allowBridgeConnectionsEnabled": "true",
    "allowGuaranteedEndpointCreateEnabled": "true",
    "apiQueueManagementCopyFromOnCreateName": null,
    "apiTopicEndpointManagementCopyFromOnCreateName": null,
    "maxConnectionCountPerClientUsername": "100",
    "serviceSmfMaxConnectionCountPerClientUsername": null,
    "serviceWebMaxConnectionCountPerClientUsername": null,
    "maxEndpointCountPerClientUsername": "100",
    "maxEgressFlowCount": "100",
    "maxIngressFlowCount": "100",
    "maxSubscriptionCount": null,
    "maxTransactedSessionCount": "100",
    "maxTransactionCount": "100",
    "queueGuaranteed1MinMsgBurst": 66000
  }
}
Example Request
Create a Client Profile
curl
curl --location -g 'https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/requests/clientProfileRequests' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {paste-your-token-here}' \
--data '{
  "operation": "create",
  "clientProfile": {
    "clientProfileName": "myClientProfile",
    "allowGuaranteedMsgSendEnabled": "true",
    "allowGuaranteedMsgReceiveEnabled": "true",
    "allowTransactedSessionsEnabled": "true",
    "allowBridgeConnectionsEnabled": "true",
    "allowGuaranteedEndpointCreateEnabled": "true",
    "apiQueueManagementCopyFromOnCreateName": null,
    "apiTopicEndpointManagementCopyFromOnCreateName": null,
    "maxConnectionCountPerClientUsername": "100",
    "serviceSmfMaxConnectionCountPerClientUsername": null,
    "serviceWebMaxConnectionCountPerClientUsername": null,
    "maxEndpointCountPerClientUsername": "100",
    "maxEgressFlowCount": "100",
    "maxIngressFlowCount": "100",
    "maxSubscriptionCount": null,
    "maxTransactedSessionCount": "100",
    "maxTransactionCount": "100",
    "queueGuaranteed1MinMsgBurst": 66000
  }
}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETGET Service Request

https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/requests/{{requestId}}

Retrieves the status and details of the specified service request.

HEADERS
Content-Type

application/json

Authorization

Bearer {paste-your-token-here}

Example Request
GET Service Request
curl
curl --location -g 'https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/requests/{{requestId}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {paste-your-token-here}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers

GETGET Client Profile

https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/clientProfiles/{{clientProfileName}}
HEADERS
Content-Type

application/json

Authorization

Bearer {paste-your-token-here}

Example Request
GET Client Profile
curl
curl --location -g 'https://api.solace.cloud/api/v0/services/{paste-your-serviceId-here}/clientProfiles/{{clientProfileName}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {paste-your-token-here}'
Example Response
No response body
This request doesn't return any response body
No response headers
This request doesn't return any response headers