Publishes packages to a custom group in the self service portal

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Creates a new SSP publish configuration for a custom group with specified packages, optional credentials, and install context settings.

Request URL

https://{serverurl}/dcapi/swDeployment/publishGroup/create

Scope

DesktopCentralCloud.SWDeployment.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/publishPackage.v1+jsonapplication/publishPackage.v1+jsonCopied!
AcceptstringMandatory
application/publishPackage.v1+jsonapplication/publishPackage.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
groupResourceIdstringOptional

Resource ID of the target custom group. Obtain from the groupResourceId field in the response of the List SSP Publish Groups API.

configTypeintegerOptional

Configuration type: 1=Computer, 2=User

packageDetailsJSON ArrayOptional

Array of package publish detail objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
packageIdlongOptional

Package ID to publish. Obtain from the packageId field in the response of the List Packages API.

packageApprovalintegerOptional

Approval type: 0 - published package without approval, 1 - published package with approval (applicable only when integrated with Service Desk Plus)

credentialDetailsJSON ObjectOptional

Optional credential details for run-as-user installs. Get available credentials from the List Credentials API.

Show Sub-Attributes
credentialIDlongOptional

Credential identifier

credentialUUIDstringOptional

Credential UUID string

credentialNamestringOptional

Display name of the credential

installUsingstringOptional

Optional install context: systemUser, targetUser, or runAsUser

allowUserToInteractbooleanOptional

Optional flag to allow user interaction during installation

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/swDeployment/publishGroup/create \
  --header 'Accept: application/publishPackage.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/publishPackage.v1+json' \
  --data '{}'

Sample Request Body

Publish packages to a computer group

Copied!
  {
    "packageDetails": [
      {
        "packageId": 10001,
        "packageApproval": 0
      },
      {
        "packageId": 10002,
        "packageApproval": 0
      }
    ],
    "configType": 1,
    "groupResourceId": "301"
  }
                
Show full

Publish with credentials and install context

Copied!
  {
    "packageDetails": [
      {
        "credentialDetails": {
          "credentialUUID": "abc-123",
          "credentialID": 100,
          "credentialName": "Admin"
        },
        "packageId": 10003,
        "installUsing": "runAsUser",
        "allowUserToInteract": true,
        "packageApproval": 1
      }
    ],
    "configType": 2,
    "groupResourceId": "302"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusMsgstring

Localized message describing the publish result. Contains success confirmation, archived package warning, or invalid package error.

- HTTP code 401

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodelong

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

INTERNAL_ERROR for publish/modify failures, SW_INTERNAL_ERROR for SSP configuration errors

errorMessagestring

Internal server error with details about the SSP publish or group operation failure

Possible Response Codes

200HTTP code
401HTTP code
500HTTP code

Sample Response: HTTP 200

Packages published successfully

Copied!
  {
    "statusMsg": "Packages published for the Group (Engineering Workstations)"
  }
                
Show full

Sample Response: HTTP 401

No access to publish

Copied!
  {
    "errorMessage": "The user has no access to publish packages.",
    "errorCode": "ACCESS_DENIED"
  }
                
Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "errorMessage": "Internal Server Error",
    "errorCode": "INTERNAL_ERROR"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.