{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Vault 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": "Vault", "type": "folder" }, "items": [ { "info": { "name": "Get a Single Vault Entry", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries/:key", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update a Vault Entry", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries/:key", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Delete a Vault Entry", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries/:key", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "key", "value": "", "type": "path" } ] }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Fetches Vault Entries Referenced in a Specific Snapshot from a Given Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries/fetch", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "referenceSnapshotId", "value": "", "type": "query" }, { "name": "sourceOrganizationId", "value": "", "type": "query" }, { "name": "fetchStrategy", "value": "", "type": "query" } ] }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Get All Vault Entries for an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" } ] }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Create a Vault Entry", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Retrieve State of Vault Entries for Specified Snapshot", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/vaultentries/missing", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "snapshotId", "value": "", "type": "query" } ] }, "docs": "
Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"VAULT_ENTRY\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" } ] } ], "bundled": true }