Retrieve the advanced registration configuration files of a model

This is for:

Developer System Administrator
In this article

The Coveo Machine Learning API configs/status endpoint lets you obtain the advanced configuration files attached to a Coveo Machine Learning (Coveo ML) model.

Ensure that you’re using an access token with Machine learning - Models - View privilege in the target organization (see Add an API key).

Making a request

The following request retrieves the advanced configuration files attached to a model:

GET https://platform.cloud.coveo.com/rest/organizations/<ORGANIZATION-ID>/machinelearning/models/<MODEL-ID>/configs/status HTTP/1.1

Authorization: Bearer **********-****-****-****-************

200 OK response body

Example
{
  "modelId": "myModelID",
  "advancedRegistrationConfigFiles": {
    "Blocklists": [
      {
        "languageCode": "en",
        "modifiedDate": "2021-Mar-29 19:10:07 UTC",
        "fileSizeInKb": 0,
        "fileDisplayName": "Blocklists_en.csv",
        "md5Hash": "65d167285d4b7555a5d58529ca8f8bba"
      }
    ],
    "AdvancedConfiguration": [
      {
        "languageCode": null,
        "modifiedDate": "2021-Mar-25 17:51:34 UTC",
        "fileSizeInKb": 0,
        "fileDisplayName": "AdvancedConfiguration.json",
        "md5Hash": "76359b884f3d6756f28a15d94d2a002a"
      }
    ]
  },
  "orgId": "myOrganizationID"
}

Reference

Authenticating

The Advanced Model Configurations API relies on the bearer HTTP authentication scheme. All HTTP requests made to the Coveo Machine Learning service must include an Authorization header with a valid access token (that is, an API key or OAuth2 token):

Authorization: Bearer <token>

To retrieve a model’s advanced registration configuration files, the <token> must grant the Machine learning - Models - View privilege in the target organization.

Parameters

When making a GET request to https://platform.cloud.coveo.com/rest/organizations/{organizationId}/machinelearning/models/{modelId}/configs/status to retrieve a model’s advanced registration configuration files, the following parameters apply (see /configs/status).

modelId (string) - required

Parameter type: path

The unique identifier of the target model (see Review model information).

Example
myOrganization_topclicks_22ec9966_0f8b_4adc_967d_65219552192a

organizationId (string) - required

Parameter type: path

The unique identifier of the target Coveo organization (see Retrieve the organization ID).

Example
myorg6j53h4