Viewing Synchronizing Status
Use the get /v1/cckm/sfdc/keys/synchronization-jobs
API to view the list of synchronization jobs and their details. Use the request query parameters to filter the results.
Request Parameter
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
Request Query Parameters
Parameter | Type | Description |
---|---|---|
id | string | Resource ID of the synchronization job. |
overall_status | string | Overall status of the synchronization job. The status could be in_progress , completed , or failed . |
organizations | string | List of IDs of the Salesforce organization resources on the CipherTrust Manager. |
skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
sort | string | Comma-delimited list of properties to sort the results. |
Example Request
Example Response
The sample output displays the list of synchronization jobs based on the specified request query parameters.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.