Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Cookies

Add Cookies

Use this API to add cookies.

post/api/cmp/v1/webscans/cookies

Request body

cookieNamestring

The name of the cookie.

lifespan'SESSION' | 'PERSISTENT' required

The duration for which the cookie remains active before expiring.

hoststring

The domain or website that created the cookie.

descriptionstring

The description of the cookie and its intended purpose.

thirdPartyDescriptionstring

The description of third-party cookies and their usage.

lengthinteger

Length of the Cookie lifespan, enter a number greater than 0 if this is a PERSISTENT cookie, otherwise leave as 0

durationTypeinteger required

The type of duration indicating whether the cookie is session-based or persistent.

cookieIdstring uuid

The unique identifier of the cookie.

customCategoryNamestring required

The custom name assigned to the cookie category.

Example request

[
  {
    "cookieName": "cookieName123",
    "lifespan": "SESSION",
    "host": "amazon.com",
    "description": "This cookie is used for advertising purposes.",
    "thirdPartyDescription": "This cookie is used for advertising purposes.",
    "length": 5,
    "cookieId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
    "customCategoryName": "C0001",
    "domainCookieCategoryList": [
      {
        "domainId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
        "customCategoryName": "C0000",
        "thirdParty": true,
        "description": "this cookies is used for targeting purposes only"
      }
    ]
  }
]

Response

Created

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.

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",
    "content": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "CookieName123__",
      "description": "This cookie is used for advertising purposes.",
      "thirdPartyDescription": "This cookie is used for advertising purposes.",
      "host": "amazon.com",
      "path": "/",
      "source": "MANUAL/SCAN",
      "cookieLifeSpan": "SESSION",
      "httpOnly": true,
      "secure": true,
      "length": 5,
      "durationType": 7
    }
  }
]