j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
updateLogpushJob
Update Logpush job. See [eCDN Logpush](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-logpush.html).
Operation ID: updateLogpushJobPUT
https://{shortCode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/{organizationId}/zones/{zoneId}/logpush/jobs/{jobId}
Request
curl "https://{shortCode}.api.commercecloud.salesforce.com/cdn/zones/v1/organizations/{organizationId}/zones/{zoneId}/logpush/jobs/{jobId}" \
-X PUT \
-H "content-type: application/json" \
-d '{
"enabled": true,
"filter": "{\"where\":{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/example-path\"}}",
"logFields": [
"ClientRequestBytes",
"ClientRequestHost",
"ClientRequestMethod"
]
}'Security
URI parameters
shortCode
string
Required
Default value:
shortCode
jobId
string
Required
zoneId
string
Required
organizationId
string
Required
An identifier for the organization the request is being made by
Minimum characters:
1
Maximum characters:
32
f_ecom_zzxy_prd
Body
Media type:
application/json
{
"enabled": true,
"filter": "{\"where\":{\"key\":\"ClientRequestPath\",\"operator\":\"contains\",\"value\":\"/example-path\"}}",
"logFields": [
"ClientRequestBytes",
"ClientRequestHost",
"ClientRequestMethod"
]
}
enabled
boolean
Flag that indicates if the job is enabled or disabled.
true
filter
string
Provides customized selection for logs you want to receive. Filters are added as escaped, formatted JSON strings. By default, all logs are included.
{"where":{"key":"ClientRequestPath","operator":"contains","value":"/example-path"}}
logFields
array of string
List of log fields. Depending on the log type, the list of fields that you can specify to be displayed in the log might vary.
[
null,
null,
null
]
Responses
Successfully enabled or disabled the Logpush job and returned job details.
{
"data": {
"jobId": 123456,
"name": "example-job-name",
"enabled": true,
"logType": "http_requests",
"logFields": [
"ClientRequestBytes",
"ClientRequestHost",
"ClientRequestMethod"
],
"destinationPath": "s3://customer-bucket/site-name/{DATE}?region=us-east-1&sse=AES256",
"lastComplete": "2023-03-14T02:09:32Z",
"lastError": "2023-01-01T00:00:27Z",
"errorMessage": ""
}
}
Body
Media type:
application/json
data
object
Required
Logpush job response