ONonetrust
Cookies

Delete Cookies

Use this API to delete cookies by the specified cookie ID or filter criteria.

delete/api/cmp/v1/webscans/cookies

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/cmp/v1/webscans/cookies
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: COOKIE

Request body

cookieIdsstring[] required

The list of cookie identifiers.

languagestring

The language code for localized content.

countryCodestring

The country code for regional settings.

deleteByFilterCriteriaboolean

This flag indicates whether to delete items based on filter conditions rather than specific identifiers.

cookieNamestring

The name of the cookie.

Example request

{
  "language": "en",
  "countryCode": "us",
  "cookieName": "cookie123"
}

Response

OK

entityIdstring uuid

The unique identifier of the entity.

entityType'SCAN' | 'DOMAIN' | 'COOKIE'

The type of entity such as cookie, tag, page, form, service, or storage.

action'ARCHIVE' | 'SCHEDULE' | 'SCHEDULE_CANCEL' | 'EDIT' | 'CREATE' | 'DELETE'

The action that was performed or is to be performed.

messagestring

The message or notification text.

contentobject

The main content or data payload of the response.

successboolean

This flag indicates whether the operation completed successfully.

Example response

[
  {
    "entityId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "entityType": "SCAN",
    "action": "ARCHIVE",
    "message": "Scan queued for archival"
  }
]

Changes

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