Microsoft Purview Retention Event Types API

Operations for managing retention event types

Operations 5

GET /security/triggerTypes/retentionEventTypes Microsoft Purview List retention event types #
POST /security/triggerTypes/retentionEventTypes Microsoft Purview Create a retention event type #
GET /security/triggerTypes/retentionEventTypes/{retentionEventTypeId} Microsoft Purview Get a retention event type #
PATCH /security/triggerTypes/retentionEventTypes/{retentionEventTypeId} Microsoft Purview Update a retention event type #
DELETE /security/triggerTypes/retentionEventTypes/{retentionEventTypeId} Microsoft Purview Delete a retention event type #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

Other Resources

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/microsoft-purview-retention-event-types-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.

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

OpenAPI Specification

microsoft-purview-retention-event-types-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Microsoft Purview Records Management Retention Event Types API
  description: APIs for managing retention labels, retention policies, and disposition review through Microsoft Graph. Helps organizations manage data retention and deletion to meet legal obligations and compliance regulations.
  version: v1.0
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
servers:
- url: https://graph.microsoft.com/v1.0
  description: Microsoft Graph v1.0 endpoint
security:
- oauth2: []
tags:
- name: Retention Event Types
  description: Operations for managing retention event types
paths:
  /security/triggerTypes/retentionEventTypes:
    get:
      operationId: listRetentionEventTypes
      summary: Microsoft Purview List retention event types
      description: Get a list of retention event types.
      tags:
      - Retention Event Types
      parameters:
      - name: $top
        in: query
        schema:
          type: integer
          format: int32
      - name: $filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Retention event types listed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/RetentionEventType'
                  '@odata.nextLink':
                    type: string
        '401':
          description: Unauthorized
    post:
      operationId: createRetentionEventType
      summary: Microsoft Purview Create a retention event type
      description: Create a new retention event type.
      tags:
      - Retention Event Types
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetentionEventType'
      responses:
        '201':
          description: Retention event type created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionEventType'
        '401':
          description: Unauthorized
  /security/triggerTypes/retentionEventTypes/{retentionEventTypeId}:
    get:
      operationId: getRetentionEventType
      summary: Microsoft Purview Get a retention event type
      description: Get a retention event type by its identifier.
      tags:
      - Retention Event Types
      parameters:
      - name: retentionEventTypeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retention event type retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionEventType'
        '401':
          description: Unauthorized
        '404':
          description: Not found
    patch:
      operationId: updateRetentionEventType
      summary: Microsoft Purview Update a retention event type
      description: Update the properties of a retention event type.
      tags:
      - Retention Event Types
      parameters:
      - name: retentionEventTypeId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetentionEventType'
      responses:
        '200':
          description: Retention event type updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetentionEventType'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteRetentionEventType
      summary: Microsoft Purview Delete a retention event type
      description: Delete a retention event type.
      tags:
      - Retention Event Types
      parameters:
      - name: retentionEventTypeId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Retention event type deleted successfully
        '401':
          description: Unauthorized
components:
  schemas:
    IdentitySet:
      type: object
      properties:
        user:
          type: object
          properties:
            displayName:
              type: string
            id:
              type: string
    RetentionEventType:
      type: object
      description: A retention event type
      properties:
        id:
          type: string
          readOnly: true
        displayName:
          type: string
        description:
          type: string
        createdDateTime:
          type: string
          format: date-time
          readOnly: true
        lastModifiedDateTime:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          $ref: '#/components/schemas/IdentitySet'
        lastModifiedBy:
          $ref: '#/components/schemas/IdentitySet'
  securitySchemes:
    oauth2:
      type: oauth2
      description: Microsoft Identity Platform OAuth2
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            RecordsManagement.Read.All: Read records management settings
            RecordsManagement.ReadWrite.All: Read and write records management settings