HEhere
config

Mark a catalog as disabled or re-enable catalog

Allows to mark a catalog status as disabled or to re-enable it.

patch/catalogs/{catalogHrn}/status

Request

  • Base URL
    https://use.apilookup.for.a.base.url
  • URL
    https://use.apilookup.for.a.base.url/catalogs/{catalogHrn}/status
  • Auth
    HTTP bearer

Path parameters

catalogHrnstring required

The HERE Resource Name (HRN) of the catalog

Request body

disabledboolean required

If set to true, then no data reads and writes can be performed against the catalog while disabled. To re-enable, set to false.

Example request

{
  "disabled": true
}

Response

OK

disabledboolean

Disabled status for catalog. If set to true, then no data reads and writes can be performed against the catalog while disabled. To re-enable, set to false.

updatedstring

Timestamp, in ISO 8601 format, when the catalog status was last updated.

idstring

The unique ID of the user or application that disabled/re-enabled the catalog.

Example response

{
  "disabled": true,
  "updated": "2022-12-12T21:06:24.831916Z",
  "id": "Mejk09M4Aq71KI5l1t2T2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.