Refresh (Deployment)

URL:
https://<root>/system/deployments/<deploymentID>/refresh
Methods:
POST
Version Introduced:
10.9

Description

The refresh operation can be used to troubleshoot microservices and pods that may be unresponsive or not functioning as expected. Performing this operation restarts the corresponding pods and re-creates the microservice.

Request parameters

ParameterDetails

async

(Optional)

Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If false , the operation is run synchronously. If true , the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false .

Values: true | false

f

The response format. The default format is html .

Values: html | json | pjson

Example usage

The following is a sample POST request for the refresh operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /context/admin/system/deployments//kvyxph9w5h3o9vgk8dixn/refresh HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

async=false&f=pjson&token=-7UDzD6pc1kKKeh2tAj_hrVWtPQyN2LpY7_zteQM754nxrEDTfZr6xBAm9TdwmNP14-WBSVng3PQ6kSiKEyYsIKRaJAktEAuJ47PyLgInSqs3orw9RemsorTu9uvFvJ0q2NExzQz3j3qOgGtJWztTSQArqUonO6gpPGiizXOdVf4wFUlEUA3oUKW9WYO_59UiV27W0SsqIkGIGy2cxCMr7gFv8fbovRkL0NPptnNpt3ppCu-HFO_cZ4m3I7Adcy1

JSON Response examples

If async is false , the following response is returned:

Use dark colors for code blocksCopy
1
{"status": "success"}

If async is true , the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it's been submitted. For more information, see the Job resource topic.

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.