Retrieving the ID of a Source

Many Coveo Cloud platform REST API operations require that you specify a value for the sourceId parameter. As its name implies, this parameter expects the unique and permanent ID of an existing source as an argument. Source ID values are typically in the following format: <organizationId>-<randomAlphaNumericSequence>.

If the ID of your Coveo Cloud organization is mycoveocloudv2organizationg8tp8wu3 and the random alphanumeric sequence that was generated for a given source is rp5rxzbdz753uhndklv2ztkfgy, then the resulting ID of that source is:

mycoveocloudv2organizationg8tp8wu3-rp5rxzbdz753uhndklv2ztkfgy.

If your organization has more than 100 sources, you may need to use the page and/or perPage query string parameter(s) to increase the number of retrieved sources. This ensures that the source that you are looking for is included in the response.

Use the Get all sources operation to find the unique and permanent ID of a source in a specific Coveo Cloud organization.

Request template

GET https://platform.cloud.coveo.com/rest/organizations/<MyOrganizationId>/sources HTTP/1.1
 
Accept: application/json
Authorization: Bearer <MyAccessToken>

In the request path:

In the Authorization HTTP header:

The body of a successful response (200 OK) is an array where each element contains information about a single source in the target Coveo Cloud organization. The id property of each element is the unique and permanent ID of the corresponding source.

The only source properties whose values cannot change once a source has been created are its id and name. Consequently, you can safely use a source name to look for its id.

Sample Request

Getting all sources in a Coveo Cloud organization

GET https://platform.cloud.coveo.com/rest/organizations/mycoveocloudv2organizationg8tp8wu3/sources HTTP/1.1
 
Accept: application/json
Authorization: Bearer **********-****-****-****-************

Successful response - 200 OK

[
  {
    "sourceType": "PUSH",
    "id": "mycoveocloudv2organizationg8tp8wu3-rp5rxzbdz753uhndklv2ztkfgy",
    "name": "My Secured Push Source",
    "owner": "asmith@example.com",
    "sourceVisibility": "SECURED",
    ...
  },
  ...
]