APIs.io Engineering Platform DLP Profiles API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 DLP Profiles API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: DLP Profiles
paths:
  /accounts/{account_id}/dlp/profiles:
    get:
      description: Lists all DLP profiles in an account.
      operationId: dlp-profiles-list-all-profiles
      parameters:
      - description: Return all profiles, including those that current account does not have access to.
        in: query
        name: all
        schema:
          type: boolean
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: List all profiles failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_ProfileArray'
                  type: object
          description: List all profiles response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform List all profiles
      tags:
      - DLP Profiles
  /accounts/{account_id}/dlp/profiles/{profile_id}:
    get:
      description: Fetches a DLP profile by ID
      operationId: dlp-profiles-get-dlp-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Get profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Profile'
                  type: object
          description: Get profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get DLP Profile
      tags:
      - DLP Profiles
  /accounts/{account_id}/dlp/profiles/custom:
    post:
      description: Creates a set of DLP custom profiles.
      operationId: dlp-profiles-create-custom-profiles
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_NewCustomProfiles'
        description: A list of new profiles to create.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: New custom profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_ProfileArray'
                  type: object
          description: New custom profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Create custom profiles
      tags:
      - DLP Profiles
  /accounts/{account_id}/dlp/profiles/custom/{profile_id}:
    delete:
      description: Deletes a DLP custom profile.
      operationId: dlp-profiles-delete-custom-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Delete custom profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Empty'
                  type: object
          description: Delete custom profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Delete custom profile
      tags:
      - DLP Profiles
    get:
      description: Fetches a custom DLP profile by id.
      operationId: dlp-profiles-get-custom-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Custom profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Profile'
                  type: object
          description: Custom profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get custom profile
      tags:
      - DLP Profiles
    put:
      description: Updates a DLP custom profile.
      operationId: dlp-profiles-update-custom-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_CustomProfileUpdate'
        description: The updated parameters for the profile.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Update custom profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Profile'
                  type: object
          description: Update custom profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update custom profile
      tags:
      - DLP Profiles
  /accounts/{account_id}/dlp/profiles/predefined/{profile_id}:
    get:
      description: Fetches a predefined DLP profile by id.
      operationId: dlp-profiles-get-predefined-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Predefined profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Profile'
                  type: object
          description: Predefined profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Get predefined profile
      tags:
      - DLP Profiles
    put:
      description: Updates a DLP predefined profile. Only supports enabling/disabling entries.
      operationId: dlp-profiles-update-predefined-profile
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          type: string
      - in: path
        name: profile_id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dlp_PredefinedProfileUpdate'
        description: The updated parameters for the predefined profile.
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dlp_api-response-common-failure'
          description: Update predefined profile failure response
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dlp_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/dlp_Profile'
                  type: object
          description: Update predefined profile response
      security:
      - api_email: []
        api_key: []
        api_token: []
      summary: APIs.io Engineering Platform Update predefined profile
      tags:
      - DLP Profiles
components:
  schemas:
    dlp_NewCustomProfiles:
      properties:
        profiles:
          items:
            $ref: '#/components/schemas/dlp_NewCustomProfile'
          type: array
      required:
      - profiles
      type: object
    dlp_EntryUpdate:
      oneOf:
      - $ref: '#/components/schemas/dlp_NewCustomEntryWithId'
      - $ref: '#/components/schemas/dlp_NewCustomEntry'
    dlp_Pattern:
      properties:
        regex:
          type: string
        validation:
          allOf:
          - $ref: '#/components/schemas/dlp_Validation'
      required:
      - regex
      type: object
    dlp_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    dlp_EntryOfNewProfile:
      oneOf:
      - $ref: '#/components/schemas/dlp_NewCustomEntry'
      - $ref: '#/components/schemas/dlp_NewWordListEntry'
    dlp_ContextAwareness:
      description: Scan the context of predefined entries to only return matches surrounded by keywords.
      properties:
        enabled:
          description: If true, scan the context of predefined entries to only return matches surrounded by keywords.
          type: boolean
        skip:
          $ref: '#/components/schemas/dlp_SkipConfig'
      required:
      - enabled
      - skip
      type: object
    dlp_NewWordListEntry:
      properties:
        enabled:
          type: boolean
        name:
          type: string
        words:
          items:
            type: string
          type: array
      required:
      - name
      - words
      - enabled
      type: object
    dlp_NewCustomEntryWithId:
      allOf:
      - $ref: '#/components/schemas/dlp_NewCustomEntry'
      - properties:
          entry_id:
            format: uuid
            type: string
        required:
        - entry_id
        type: object
    dlp_SkipConfig:
      description: Content types to exclude from context analysis and return all matches.
      properties:
        files:
          description: If the content type is a file, skip context analysis and return all matches.
          type: boolean
      required:
      - files
      type: object
    dlp_NewCustomEntry:
      properties:
        enabled:
          type: boolean
        name:
          type: string
        pattern:
          $ref: '#/components/schemas/dlp_Pattern'
      required:
      - name
      - pattern
      - enabled
      type: object
    dlp_SharedEntryUpdate:
      discriminator:
        propertyName: entry_type
      oneOf:
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - predefined
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - integration
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - exact_data
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
    dlp_IntegrationProfile:
      properties:
        created_at:
          format: date-time
          type: string
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          format: uuid
          type: string
        name:
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
      - entries
      - created_at
      - updated_at
      type: object
    dlp_PredefinedProfileUpdate:
      properties:
        allowed_match_count:
          format: int32
          nullable: true
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        entries:
          items:
            $ref: '#/components/schemas/dlp_PredefinedEntryUpdate'
          type: array
        ocr_enabled:
          type: boolean
      required:
      - entries
      type: object
    dlp_PredefinedEntryUpdate:
      properties:
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
      required:
      - id
      - enabled
      type: object
    dlp_NewCustomProfile:
      properties:
        allowed_match_count:
          default: 0
          description: Related DLP policies will trigger when the match count exceeds the number set.
          example: 5
          format: int32
          maximum: 1000
          minimum: 0
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_EntryOfNewProfile'
          type: array
        name:
          type: string
        ocr_enabled:
          type: boolean
        shared_entries:
          description: Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).
          items:
            $ref: '#/components/schemas/dlp_NewSharedEntry'
          type: array
      required:
      - name
      - entries
      type: object
    dlp_Validation:
      enum:
      - luhn
      type: string
    dlp_Profile:
      discriminator:
        propertyName: type
      oneOf:
      - allOf:
        - $ref: '#/components/schemas/dlp_CustomProfile'
        - properties:
            type:
              enum:
              - custom
              type: string
          required:
          - type
          type: object
        title: Custom Profile
      - allOf:
        - $ref: '#/components/schemas/dlp_PredefinedProfile'
        - properties:
            type:
              enum:
              - predefined
              type: string
          required:
          - type
          type: object
        title: Predefined Profile
      - allOf:
        - $ref: '#/components/schemas/dlp_IntegrationProfile'
        - properties:
            type:
              enum:
              - integration
              type: string
          required:
          - type
          type: object
        title: Integration Profile
    dlp_WordListEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
        word_list: {}
      required:
      - id
      - name
      - created_at
      - updated_at
      - word_list
      - enabled
      type: object
    dlp_CustomEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        pattern:
          $ref: '#/components/schemas/dlp_Pattern'
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
      - created_at
      - updated_at
      - pattern
      - enabled
      type: object
    dlp_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dlp_api-response-common'
      type: object
    dlp_IntegrationEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
      - created_at
      - updated_at
      - enabled
      type: object
    dlp_PredefinedEntry:
      properties:
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        profile_id:
          format: uuid
          nullable: true
          type: string
      required:
      - id
      - name
      - enabled
      type: object
    dlp_ExactDataEntry:
      properties:
        created_at:
          format: date-time
          type: string
        enabled:
          type: boolean
        id:
          format: uuid
          type: string
        name:
          type: string
        secret:
          type: boolean
        updated_at:
          format: date-time
          type: string
      required:
      - id
      - name
      - created_at
      - updated_at
      - enabled
      - secret
      type: object
    dlp_CustomProfileUpdate:
      properties:
        allowed_match_count:
          format: int32
          nullable: true
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          description: Custom entries from this profile
          items:
            $ref: '#/components/schemas/dlp_EntryUpdate'
          type: array
        name:
          type: string
        ocr_enabled:
          type: boolean
        shared_entries:
          description: Other entries, e.g. predefined or integration.
          items:
            $ref: '#/components/schemas/dlp_SharedEntryUpdate'
          type: array
      required:
      - name
      - entries
      type: object
    dlp_ProfileArray:
      items:
        $ref: '#/components/schemas/dlp_Profile'
      type: array
    dlp_Entry:
      discriminator:
        propertyName: type
      oneOf:
      - allOf:
        - $ref: '#/components/schemas/dlp_CustomEntry'
        - properties:
            type:
              enum:
              - custom
              type: string
          required:
          - type
          type: object
        title: Custom Entry
      - allOf:
        - $ref: '#/components/schemas/dlp_PredefinedEntry'
        - properties:
            type:
              enum:
              - predefined
              type: string
          required:
          - type
          type: object
        title: Predefined Entry
      - allOf:
        - $ref: '#/components/schemas/dlp_IntegrationEntry'
        - properties:
            type:
              enum:
              - integration
              type: string
          required:
          - type
          type: object
        title: Integration Entry
      - allOf:
        - $ref: '#/components/schemas/dlp_ExactDataEntry'
        - properties:
            type:
              enum:
              - exact_data
              type: string
          required:
          - type
          type: object
        title: Exact Data Entry
      - allOf:
        - $ref: '#/components/schemas/dlp_WordListEntry'
        - properties:
            type:
              enum:
              - word_list
              type: string
          required:
          - type
          type: object
        title: Word List Entry
    dlp_CustomProfile:
      properties:
        allowed_match_count:
          default: 0
          description: Related DLP policies will trigger when the match count exceeds the number set.
          example: 5
          format: int32
          maximum: 1000
          minimum: 0
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        created_at:
          description: When the profile was created
          format: date-time
          type: string
        description:
          description: The description of the profile
          nullable: true
          type: string
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          description: The id of the profile (uuid)
          format: uuid
          type: string
        name:
          description: The name of the profile
          type: string
        ocr_enabled:
          type: boolean
        updated_at:
          description: When the profile was lasted updated
          format: date-time
          type: string
      required:
      - id
      - name
      - entries
      - created_at
      - updated_at
      - allowed_match_count
      - context_awareness
      - ocr_enabled
      type: object
    dlp_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dlp_messages'
        messages:
          $ref: '#/components/schemas/dlp_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    dlp_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dlp_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dlp_messages'
          example: []
        result:
          enum:
          - null
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    dlp_PredefinedProfile:
      properties:
        allowed_match_count:
          format: int32
          type: integer
        context_awareness:
          $ref: '#/components/schemas/dlp_ContextAwareness'
        entries:
          items:
            $ref: '#/components/schemas/dlp_Entry'
          type: array
        id:
          description: The id of the predefined profile (uuid)
          format: uuid
          type: string
        name:
          description: The name of the predefined profile
          type: string
        ocr_enabled:
          type: boolean
        open_access:
          description: Whether this profile can be accessed by anyone
          type: boolean
      required:
      - id
      - name
      - entries
      - allowed_match_count
      type: object
    dlp_NewSharedEntry:
      discriminator:
        propertyName: entry_type
      oneOf:
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - custom
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - predefined
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - integration
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
      - properties:
          enabled:
            type: boolean
          entry_id:
            format: uuid
            type: string
          entry_type:
            enum:
            - exact_data
            type: string
        required:
        - entry_id
        - enabled
        - entry_type
        type: object
    dlp_Empty:
      nullable: true
      type: object
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true