Osano

Osano Cmp Rules API

The cmpRules API from Osano — 2 operation(s) for cmprules.

GitHub OpenAPI

Operations 3

POST /v1/cookie-consent/rules Create New Cookie Consent Rules #
PATCH /v1/cookie-consent/rules/{ruleId} Update Cookie Consent Rule #
DELETE /v1/cookie-consent/rules/{ruleId} Delete Cookie Consent Rule #

Documentation

📖
Documentation
https://developers.osano.com/customer-rest-api/developer-api-doc
📖
APIReference
https://developers.osano.com/customer-rest-api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/authentication/osano-authentication.yml
📖
Documentation
https://developers.osano.com/uc/
📖
APIReference
https://developers.osano.com/uc/core-api/openapi

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/openapi/osano-cmprules-api-openapi.yml

SDKs

📦
SDK
https://developers.osano.com/uc/js-sdk/

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/errors/osano-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/data-model/osano-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/osano/refs/heads/main/conventions/osano-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/osano-cmprules-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

osano-cmprules-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Osano API Reference Cmp Rules API
  version: 1.0.0
  description: '# Introduction

    This is the Osano API.'
  x-logo:
    url: https://www.osano.com/hubfs/Imported%20images/Logo.svg
    altText: Osano
servers:
- url: https://api.osano.com
  description: Production API
security:
- ApiKeyAuth: []
tags:
- name: cmpRules
  x-displayName: Cookie Consent Discoveries & Rules
paths:
  /v1/cookie-consent/rules:
    post:
      summary: Create New Cookie Consent Rules
      description: Create one or more Cookie Consent Rules. The maximum number of rules that may be created in a single call is 100. If the request is successful, the response will contain a list of the created rules.
      tags:
      - cmpRules
      operationId: createRules
      requestBody:
        $ref: '#/components/requestBodies/CmpRulesPost'
      responses:
        '200':
          $ref: '#/components/responses/CmpRulesList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v1/cookie-consent/rules/{ruleId}:
    patch:
      summary: Update Cookie Consent Rule
      description: Update an existing Cookie Consent Rule by ID.
      tags:
      - cmpRules
      operationId: updateRule
      parameters:
      - name: ruleId
        required: true
        in: path
        description: The identifier of the Cookie Consent Rule to be updated.
        schema:
          type: integer
          format: int32
      requestBody:
        $ref: '#/components/requestBodies/CmpRulePatch'
      responses:
        '200':
          $ref: '#/components/responses/CmpRulePatch'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      summary: Delete Cookie Consent Rule
      description: Deletes a single Cookie Consent Rule by ID.
      tags:
      - cmpRules
      operationId: deleteRule
      parameters:
      - name: ruleId
        required: true
        in: path
        description: The identifier of the Cookie Consent Rule to be deleted.
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: Success
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  responses:
    CmpRulePatch:
      description: Success
      content:
        application/json:
          schema:
            oneOf:
            - type: object
              allOf:
              - $ref: '#/components/schemas/CmpRule'
              - $ref: '#/components/schemas/CmpRuleResponseProperties'
            - type: object
              allOf:
              - $ref: '#/components/schemas/CmpCookieRule'
              - $ref: '#/components/schemas/CmpRuleResponseProperties'
    CmpRulesList:
      description: Success
      content:
        application/json:
          schema:
            type: object
            properties:
              items:
                type: array
                items:
                  oneOf:
                  - type: object
                    allOf:
                    - $ref: '#/components/schemas/CmpRule'
                    - $ref: '#/components/schemas/CmpRuleResponseProperties'
                  - type: object
                    allOf:
                    - $ref: '#/components/schemas/CmpCookieRule'
                    - $ref: '#/components/schemas/CmpRuleResponseProperties'
  schemas:
    CmpRuleRequiredProps:
      allOf:
      - $ref: '#/components/schemas/CmpRule'
      - type: object
        required:
        - classification
        - rule
    CmpCookieRuleRequiredProps:
      allOf:
      - $ref: '#/components/schemas/CmpCookieRule'
      - type: object
        required:
        - classification
        - rule
    CmpCookieRule:
      allOf:
      - $ref: '#/components/schemas/CmpRule'
      - type: object
        properties:
          description:
            type:
            - string
            - 'null'
            description: A description of the cookie to be used in disclosures.
            maxLength: 1000
          expiry:
            type:
            - string
            - 'null'
            description: The length of time that must elapse before the cookie expires.
            maxLength: 50
    ErrorResponse:
      type: object
      additionalProperties: true
      properties:
        message:
          type: string
    CmpRule:
      type: object
      minProperties: 1
      properties:
        classification:
          type: string
          enum:
          - ANALYTICS
          - BLACKLISTED
          - ESSENTIAL
          - HIDDEN
          - MARKETING
          - PERSONALIZATION
        rule:
          type: string
          description: The type of the rule.
          minLength: 3
          maxLength: 1000
        disclosure:
          type: boolean
          description: Whether the rule should be disclosed. If omitted, this property will default to `false`.
        title:
          type:
          - string
          - 'null'
          description: The title of the rule. This is used in the consent disclosure in place of the rule when defined.
          maxLength: 64
        vendorName:
          type:
          - string
          - 'null'
          description: The value of the rule.
          maxLength: 100
        ruleType:
          type:
          - string
          - 'null'
          enum:
          - FILENAME
          - DOMAIN
          - PATH
          - REGEXP
          - STARTS_WITH
          - ENDS_WITH
          - CONTAINS
          - EXACT_MATCH
          description: The type classification of the rule pattern.
    CmpRuleResponseProperties:
      type: object
      additionalProperties: false
      properties:
        type:
          type: string
          enum:
          - cookie
          - script
          - iframe
        ruleId:
          type: integer
          format: int32
        configId:
          type: string
          format: uuid
        vendorId:
          type: string
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        ruleType:
          type:
          - string
          - 'null'
          enum:
          - FILENAME
          - DOMAIN
          - PATH
          - REGEXP
          - STARTS_WITH
          - ENDS_WITH
          - CONTAINS
          - EXACT_MATCH
  requestBodies:
    CmpRulePatch:
      description: The Cookie Consent Rule property(ies) to be updated.
      required: true
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/CmpRule'
            - $ref: '#/components/schemas/CmpCookieRule'
    CmpRulesPost:
      description: The Cookie Consent Rule(s) to be created and the ID(s) of the config(s) to create them for.
      required: true
      content:
        application/json:
          schema:
            type: object
            required:
            - configIds
            properties:
              configIds:
                type: array
                minItems: 1
                maxItems: 25
                items:
                  type: string
                  format: uuid
              cookies:
                type: array
                minItems: 1
                items:
                  $ref: '#/components/schemas/CmpCookieRuleRequiredProps'
              iframes:
                type: array
                minItems: 1
                items:
                  $ref: '#/components/schemas/CmpRuleRequiredProps'
              scripts:
                type: array
                minItems: 1
                items:
                  $ref: '#/components/schemas/CmpRuleRequiredProps'
              localStorage:
                type: array
                minItems: 1
                items:
                  $ref: '#/components/schemas/CmpRuleRequiredProps'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-osano-api-key
x-tagGroups:
- name: General
  tags:
  - cmp
  - cmpRules
  - connectors
  - dsar
  - dataDiscovery
  - dsarActionItems
  - subjectRightsPortal
  - customerInsights