Google Dialogflow Security Settings API

The Security Settings API from Google Dialogflow — 2 operation(s) for security settings.

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v3/projects/{projectsId}/locations/{locationsId}/securitySettings List security settings in a location · Dialogflow projects locations security settings list #
Ask an LLM
“Which Dialogflow CX security settings profiles exist in my project and region?”
“Can I page through all security settings in a location?”
Tell an agent
List security settings in project {project}, location {location}.
Show {page_size} security settings per page in {location}.
POST /v3/projects/{projectsId}/locations/{locationsId}/securitySettings Create security settings for redaction and retention · Dialogflow projects locations security settings create #
Ask an LLM
“How do I make my conversational agents redact sensitive data from logs?”
“Can I set how many days conversation data is retained before it is purged?”
Tell an agent
Create security settings {display_name} in project {project}, location {location} with a {days}-day retention window.
Add security settings {display_name} using inspect template {inspect_template} and redaction strategy {strategy}.
GET /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId} Retrieve security settings · Dialogflow projects locations security settings get #
Ask an LLM
“What redaction and retention rules does a security settings profile apply?”
“Can I view one security settings resource by ID?”
Tell an agent
Get security settings {settings} in project {project}, location {location}.
Show the redaction and retention configuration of {settings}.
PATCH /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId} Update security settings · Dialogflow projects locations security settings patch #
Ask an LLM
“How do I shorten the retention period on existing security settings?”
“Can I change which data types get purged or how audio is exported?”
Tell an agent
Change the retention window of security settings {settings} in project {project}, location {location} to {days} days.
Set purge data types {purge_types} on security settings {settings}.
DELETE /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId} Delete security settings · Dialogflow projects locations security settings delete #
Ask an LLM
“Can I delete a security settings profile no agent uses anymore?”
“Is removing security settings done by its ID?”
Tell an agent destructive · confirm first
Delete security settings {settings} in project {project}, location {location}.
Remove the security settings profile {settings}.

Documentation

Specifications

Other Resources

🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v3.json
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v3beta1.json
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/session.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/agent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/webhook.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/cx-v3/tool.proto
🔗
Pricing
https://cloud.google.com/dialogflow/pricing
🔗
Console
https://dialogflow.cloud.google.com/cx
🔗
Webhooks
https://cloud.google.com/dialogflow/cx/docs/concept/webhook
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v2.json
🔗
Discovery
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/discovery/google-dialogflow-v2beta1.json
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/session.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/agent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/intent.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/google-dialogflow/refs/heads/main/grpc/v2/webhook.proto
🔗
Console
https://dialogflow.cloud.google.com/
🔗
Webhooks
https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook

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/google-dialogflow:google-dialogflow-security-settings-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

google-dialogflow-security-settings-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dialogflow CX API (v3) - Conversational Agents Security…
  version: v3
  description: Dialogflow CX (Conversational Agents) builds flow- and playbook-based agents with pages, routes, webhooks, tools, test cases, environments, experiments and data stores. This OpenAPI is a mechanical conversion of the first-party Google Discovery Document served by dialogflow.googleapis.com.
  contact:
    name: Google Cloud
    url: https://cloud.google.com/dialogflow/
  termsOfService: https://cloud.google.com/terms
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
  x-discovery-source: https://dialogflow.googleapis.com/$discovery/rest?version=v3
  x-discovery-revision: '20260825'
  x-discovery-id: dialogflow:v3
servers:
- url: https://dialogflow.googleapis.com
  description: Dialogflow API
security:
- OAuth2:
  - https://www.googleapis.com/auth/cloud-platform
  - https://www.googleapis.com/auth/dialogflow
- BearerAuth: []
tags:
- name: Security Settings
paths:
  /v3/projects/{projectsId}/locations/{locationsId}/securitySettings:
    get:
      operationId: dialogflow_projects_locations_securitySettings_list
      tags:
      - Security Settings
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: pageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: pageToken
        in: query
        schema:
          type: string
      x-discovery-path-template: v3/{parent}/securitySettings
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3ListSecuritySettingsResponse'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations security settings list
      x-summary-source: derived
    post:
      operationId: dialogflow_projects_locations_securitySettings_create
      tags:
      - Security Settings
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `parent`. Resource name pattern: `^projects/[^/]+/locations/[^/]+$`.'
        required: true
        schema:
          type: string
      x-discovery-path-template: v3/{parent}/securitySettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations security settings create
      x-summary-source: derived
  /v3/projects/{projectsId}/locations/{locationsId}/securitySettings/{securitySettingsId}:
    get:
      operationId: dialogflow_projects_locations_securitySettings_get
      tags:
      - Security Settings
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: securitySettingsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      x-discovery-path-template: v3/{name}
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations security settings get
      x-summary-source: derived
    patch:
      operationId: dialogflow_projects_locations_securitySettings_patch
      tags:
      - Security Settings
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: securitySettingsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: updateMask
        in: query
        schema:
          type: string
      x-discovery-path-template: v3/{name}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations security settings patch
      x-summary-source: derived
    delete:
      operationId: dialogflow_projects_locations_securitySettings_delete
      tags:
      - Security Settings
      parameters:
      - name: projectsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: locationsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      - name: securitySettingsId
        in: path
        description: 'Part of `name`. Resource name pattern: `^projects/[^/]+/locations/[^/]+/securitySettings/[^/]+$`.'
        required: true
        schema:
          type: string
      x-discovery-path-template: v3/{name}
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleProtobufEmpty'
        default:
          description: Error response (google.rpc.Status)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcStatus'
      security:
      - OAuth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/dialogflow
      - BearerAuth: []
      summary: Dialogflow projects locations security settings delete
      x-summary-source: derived
components:
  schemas:
    GoogleCloudDialogflowCxV3SecuritySettings:
      type: object
      properties:
        insightsExportSettings:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings'
        redactionScope:
          type: string
          enum:
          - REDACTION_SCOPE_UNSPECIFIED
          - REDACT_DISK_STORAGE
          x-enumDescriptions:
          - ''
          - ''
        name:
          type: string
        audioExportSettings:
          $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings'
        displayName:
          type: string
        deidentifyTemplate:
          type: string
        inspectTemplate:
          type: string
        purgeDataTypes:
          type: array
          items:
            type: string
            enum:
            - PURGE_DATA_TYPE_UNSPECIFIED
            - DIALOGFLOW_HISTORY
            x-enumDescriptions:
            - ''
            - ''
        retentionWindowDays:
          type: integer
          format: int32
        redactionStrategy:
          type: string
          enum:
          - REDACTION_STRATEGY_UNSPECIFIED
          - REDACT_WITH_SERVICE
          x-enumDescriptions:
          - ''
          - ''
        retentionStrategy:
          type: string
          enum:
          - RETENTION_STRATEGY_UNSPECIFIED
          - REMOVE_AFTER_CONVERSATION
          x-enumDescriptions:
          - ''
          - ''
    GoogleCloudDialogflowCxV3SecuritySettingsInsightsExportSettings:
      type: object
      properties:
        enableInsightsExport:
          type: boolean
    GoogleProtobufEmpty:
      type: object
    GoogleCloudDialogflowCxV3ListSecuritySettingsResponse:
      type: object
      properties:
        nextPageToken:
          type: string
        securitySettings:
          type: array
          items:
            $ref: '#/components/schemas/GoogleCloudDialogflowCxV3SecuritySettings'
    GoogleRpcStatus:
      type: object
      properties:
        message:
          type: string
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            type: object
            additionalProperties:
              description: Properties of the object. Contains field @type with type URL.
    GoogleCloudDialogflowCxV3SecuritySettingsAudioExportSettings:
      type: object
      properties:
        enableAudioRedaction:
          type: boolean
        gcsBucket:
          type: string
        audioFormat:
          type: string
          enum:
          - AUDIO_FORMAT_UNSPECIFIED
          - MULAW
          - MP3
          - OGG
          x-enumDescriptions:
          - ''
          - ''
          - ''
          - ''
        storeTtsAudio:
          type: boolean
        audioExportPattern:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      description: Google OAuth 2.0. Scopes are declared per operation in the Discovery Document.
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
            https://www.googleapis.com/auth/dialogflow: View, manage and query your Dialogflow agents
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Google OAuth 2.0 access token or service-account-minted bearer token, sent as Authorization: Bearer <token>.'
externalDocs:
  description: Dialogflow CX documentation
  url: https://cloud.google.com/dialogflow/cx/docs