{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Source Status API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Source Status", "type": "folder" }, "items": [ { "info": { "name": "Set the Status of a Push Source", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/organizations/:organizationId/sources/:sourceId/status", "params": [ { "name": "statusType", "value": "", "type": "query", "description": "The status to set the Push source to. \nThe possible values are: `INCREMENTAL`, `REFRESH`, `REBUILD`, and `IDLE`. \n**Example:** `REBUILD`" }, { "name": "sourceId", "value": "", "type": "path", "description": "The unique identifier of the target Push source (see [Creating a Push Source](https://developers.coveo.com/x/34s9Ag)). \n**Example:** `rp5rxzbdz753uhndklv2ztkfgy-mycoveocloudv2organizationg8tp8wu3`" }, { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target Coveo Cloud V2 organization. \n**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Modifies the current status of a Push source. \nThis operation allows you to update the activity logs of a Push source (and consequently the activity indicators in the Coveo Cloud V2 administration console). \nPushing an *active* source status (i.e., `REBUILD`, `REFRESH`, or `INCREMENTAL`) creates an activity. Pushing the `IDLE` status terminates the ongoing activity and marks it as completed." } ] } ], "bundled": true }