Delphix HookTemplates API

openapi: 3.0.0
info:
  title: Delphix DCT Algorithms HookTemplates API
  version: 3.28.0
  description: Delphix DCT API
  contact:
    name: Delphix Support
    url: https://portal.perforce.com/s/
    email: support@delphix.com
servers:
- url: /dct/v3
security:
- ApiKeyAuth: []
tags:
- name: HookTemplates
paths:
  /hook-templates:
    get:
      tags:
      - HookTemplates
      summary: Fetch a list of all hook templates
      operationId: list_hook_templates
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hookTemplatesSortParam'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: ListHookTemplatesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HookTemplate'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
    post:
      summary: Create a Hook Template.
      operationId: create_hook_template
      tags:
      - HookTemplates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHookTemplateParameters'
        description: The parameters to create a hook template.
        required: true
      responses:
        '201':
          description: Hook Template created
          content:
            application/json:
              schema:
                type: object
                title: CreateHookTemplateResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  hook_template:
                    $ref: '#/components/schemas/HookTemplate'
                    description: The hook template that was created.
  /hook-templates/{hookTemplateId}:
    parameters:
    - $ref: '#/components/parameters/hookTemplateIdParam'
    get:
      tags:
      - HookTemplates
      summary: Fetch Hook Template by ID
      operationId: get_hook_template_by_id
      responses:
        '200':
          description: Returns a single hook template
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HookTemplate'
        '404':
          description: Hook template not found
    delete:
      tags:
      - HookTemplates
      summary: Delete a Hook Template.
      operationId: delete_hook_template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: HookTemplateDeleteJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
    patch:
      tags:
      - HookTemplates
      summary: Update a Hook Template.
      operationId: update_hook_template
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHookTemplateParameters'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: HookTemplateUpdateJobResponse
                properties:
                  job:
                    $ref: '#/components/schemas/Job'
                    description: The initiated job.
                  hook_template:
                    $ref: '#/components/schemas/HookTemplate'
                    description: The policy that was updated.
  /hook-templates/search:
    post:
      tags:
      - HookTemplates
      summary: Search Hook Templates.
      operationId: search_hook_templates
      x-filterable:
        fields:
          id:
            type: string
          name:
            type: string
          description:
            type: string
          shell:
            type: string
          command:
            type: string
          dct_managed:
            type: boolean
          engine_id:
            type: integer
          cred_env_vars:
            type: array[object]
            fields:
              base_var_name:
                type: string
              vault_username:
                type: string
              vault:
                type: string
              hashicorp_vault_engine:
                type: string
              hashicorp_vault_username_key:
                type: string
              azure_vault_name:
                type: string
              azure_vault_username_key:
                type: string
          tags:
            type: array[object]
            fields:
              key:
                type: string
              value:
                type: string
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/hookTemplatesSortParam'
      requestBody:
        $ref: '#/components/requestBodies/SearchBody'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                title: SearchHookTemplatesResponse
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/HookTemplate'
                  response_metadata:
                    $ref: '#/components/schemas/PaginatedResponseMetadata'
  /hook-templates/{hookTemplateId}/tags:
    parameters:
    - $ref: '#/components/parameters/hookTemplateIdParam'
    post:
      tags:
      - HookTemplates
      summary: Create tags for a Hook Template.
      operationId: create_hook_template_tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagsRequest'
        description: Tags information for Hook Template.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
    get:
      tags:
      - HookTemplates
      summary: Get tags for a Hook Template.
      operationId: get_hook_template_tags
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagsResponse'
  /hook-templates/{hookTemplateId}/tags/delete:
    parameters:
    - $ref: '#/components/parameters/hookTemplateIdParam'
    post:
      tags:
      - HookTemplates
      summary: Delete tags for a Hook Template.
      operationId: delete_hook_template_tags
      requestBody:
        $ref: '#/components/requestBodies/DeleteTags'
      responses:
        '204':
          description: No Content
components:
  schemas:
    Tag:
      type: object
      required:
      - key
      - value
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
    VirtualizationTaskEvent:
      deprecated: true
      properties:
        message_details:
          type: string
    Engine:
      properties:
        engine_id:
          type: string
          minLength: 1
          maxLength: 4000
        engine_name:
          type: string
          minLength: 1
          maxLength: 4000
    PaginatedResponseMetadata:
      type: object
      properties:
        prev_cursor:
          description: Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        next_cursor:
          description: Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.
          type: string
        total:
          description: The total number of results. This value may not be provided.
          type: integer
          format: int_64
    JobTaskEvent:
      properties:
        message_details:
          type: string
    DeleteTag:
      type: object
      properties:
        key:
          description: Key of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: key-1
        value:
          description: Value of the tag
          type: string
          minLength: 1
          maxLength: 4000
          example: value-1
        tags:
          description: List of tags to be deleted
          type: array
          minItems: 1
          maxItems: 1000
          uniqueItems: true
          items:
            $ref: '#/components/schemas/Tag'
    JobTask:
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/JobTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    TagsRequest:
      type: object
      required:
      - tags
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          minItems: 1
          maxItems: 1000
          uniqueItems: true
    HookTemplate:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        dct_managed:
          description: Whether this hook template is managed by DCT or by an individual Delphix Engine.
          type: boolean
        description:
          type: string
        shell:
          type: string
          enum:
          - bash
          - shell
          - expect
          - ps
          - psd
          default: bash
        command:
          type: string
        credentials_env_vars:
          description: List of environment variables that will contain credentials for this operation.
          type: array
          items:
            $ref: '#/components/schemas/CredentialsEnvVariable'
        engine_id:
          type: string
        compatible_engine_id:
          type: string
        tags:
          description: The tags that are applied to this hook template.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    SearchBody:
      description: Search body.
      type: object
      properties:
        filter_expression:
          type: string
          minLength: 5
          maxLength: 50000
          example: string_field CONTAINS "over" AND numberic_field GT 9000 OR string_field2 EQ "Goku"
    VirtualizationTask:
      deprecated: true
      properties:
        id:
          type: string
        parent_job_id:
          type: string
        start_time:
          type: string
          format: date-time
        end_time:
          type: string
          format: date-time
        title:
          type: string
        percent_complete:
          type: integer
          minimum: 0
          maximum: 100
        events:
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTaskEvent'
        status:
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
    UpdateHookTemplateParameters:
      type: object
      properties:
        name:
          type: string
          description: Name of the hook template.
          minLength: 1
          maxLength: 256
          example: Hook Template 1
        description:
          type: string
          description: Description of the hook template.
        shell:
          type: string
          enum:
          - bash
          - shell
          - expect
          - ps
          - psd
          default: bash
        command:
          type: string
          minLength: 1
          maxLength: 131072
        credentials_env_vars:
          description: List of environment variables that will contain credentials for this operation.
          type: array
          items:
            $ref: '#/components/schemas/CredentialsEnvVariable'
    CreateHookTemplateParameters:
      type: object
      required:
      - name
      - command
      properties:
        name:
          type: string
          description: Name of the hook template.
          minLength: 1
          maxLength: 256
          example: Hook Template 1
        description:
          type: string
          description: Description of the hook template.
        shell:
          type: string
          enum:
          - bash
          - shell
          - expect
          - ps
          - psd
          default: bash
        command:
          type: string
          minLength: 1
          maxLength: 131072
        credentials_env_vars:
          description: List of environment variables that will contain credentials for this operation.
          type: array
          items:
            $ref: '#/components/schemas/CredentialsEnvVariable'
        tags:
          description: The tags to be created for the hook template.
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    TagsResponse:
      type: object
      properties:
        tags:
          description: Array of tags with key value pairs
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    Job:
      description: An asynchronous task.
      type: object
      properties:
        id:
          description: The Job entity ID.
          type: string
          example: job-123
        status:
          description: The status of the job.
          type: string
          enum:
          - PENDING
          - STARTED
          - TIMEDOUT
          - RUNNING
          - CANCELED
          - FAILED
          - SUSPENDED
          - WAITING
          - COMPLETED
          - ABANDONED
          example: RUNNING
        is_waiting_for_telemetry:
          description: Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.
          type: boolean
        type:
          description: The type of job being done.
          type: string
          example: DB_REFRESH
        localized_type:
          description: The i18n translated type of job being done.
          type: string
          example: DB Refresh
        error_details:
          description: Details about the failure for FAILED jobs.
          type: string
          example: Unable to connect to the engine.
        warning_message:
          description: Warnings for the job.
          type: string
          example: 'Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.'
        target_id:
          description: A reference to the job's target.
          type: string
          example: vdb-123
        target_name:
          description: A reference to the job's target name.
          type: string
          example: vdb
        start_time:
          description: The time the job started executing.
          type: string
          format: date-time
          example: '2022-01-02T05:11:24.148000+00:00'
        update_time:
          description: The time the job was last updated.
          type: string
          format: date-time
          example: '2022-01-02T06:11:24.148000+00:00'
        trace_id:
          description: traceId of the request which created this Job
          type: string
        engine_ids:
          description: IDs of the engines this Job is executing on.
          type: array
          items:
            type: string
          deprecated: true
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        engines:
          type: array
          items:
            $ref: '#/components/schemas/Engine'
        account_id:
          description: The ID of the account who initiated this job.
          type: integer
          example: 1
        account_name:
          description: The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-<id>.
          type: string
          example: User 1
        compliance_node_id:
          description: The ID of the associated compliance node, if applicable.
          type: string
          nullable: true
        compliance_node_name:
          description: The name of the associated compliance node, if applicable.
          type: string
          nullable: true
        percent_complete:
          description: Completion percentage of the Job.
          type: integer
          minimum: 0
          maximum: 100
          example: '50'
        virtualization_tasks:
          deprecated: true
          type: array
          items:
            $ref: '#/components/schemas/VirtualizationTask'
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/JobTask'
        execution_id:
          description: The ID of the associated masking execution, if any.
          type: string
          nullable: true
        result_type:
          description: The type of the job result. This is the type of the object present in the result.
          type: string
        result:
          description: The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.
          type: object
      discriminator:
        propertyName: class_type
    CredentialsEnvVariable:
      required:
      - base_var_name
      properties:
        base_var_name:
          type: string
          description: Base name of the environment variables. Variables are named by appending '_USER', '_PASSWORD', '_PUBKEY' and '_PRIVKEY' to this base name, respectively. Variables whose values are not entered or are not present in the type of credential or vault selected, will not be set.
          minLength: 1
          maxLength: 256
        password:
          x-dct-toolkit-credential-field: true
          type: string
          description: Password to assign to the environment variables.
          minLength: 1
          maxLength: 256
          example: password
        vault_username:
          type: string
          description: Delphix display name for the vault user.
          minLength: 1
          maxLength: 256
          example: my-vault
        vault:
          type: string
          description: The name or reference of the vault to assign to the environment variables.
          minLength: 1
          maxLength: 256
          example: 1-VAULT-1
        hashicorp_vault_engine:
          type: string
          description: Vault engine name where the credential is stored.
          minLength: 1
          maxLength: 256
          example: kv
        hashicorp_vault_secret_path:
          type: string
          description: Path in the vault engine where the credential is stored.
          minLength: 1
          maxLength: 256
          example: oracle-env
        hashicorp_vault_username_key:
          type: string
          description: Hashicorp vault key for the username in the key-value store.
          minLength: 1
          maxLength: 256
          example: username
        hashicorp_vault_secret_key:
          type: string
          description: Hashicorp vault key for the password in the key-value store.
          minLength: 1
          maxLength: 256
          example: secret
        azure_vault_name:
          type: string
          description: Azure key vault name.
          minLength: 1
          maxLength: 256
          example: azure_vault
        azure_vault_username_key:
          type: string
          description: Azure vault key in the key-value store.
          minLength: 1
          maxLength: 256
          example: username
        azure_vault_secret_key:
          type: string
          description: Azure vault key in the key-value store.
          minLength: 1
          maxLength: 256
          example: secret
        cyberark_vault_query_string:
          type: string
          description: Query to find a credential in the CyberArk vault.
          minLength: 1
          maxLength: 256
          example: Safe=Test;Folder=Test;Object=Test
        credential_type:
          type: string
          description: Credential type of the credential environment variable
          minLength: 1
          maxLength: 256
          example: PasswordCredential
        element_id:
          type: string
          description: Element ID of the credential environment variable. Omit to create a new credential. Include an existing element_id to update that credential. Any existing credential whose element_id is omitted from the request will be deleted. An element_id that does not match any existing credential is silently ignored.
          minLength: 1
          maxLength: 256
          example: 35
        type:
          type: string
          description: Type of the credential environment variable
          minLength: 1
          maxLength: 256
          example: CredentialsEnvVars
  requestBodies:
    SearchBody:
      x-skip-codegen-attr: description
      description: 'A request body containing a filter expression. This enables searching

        for items matching arbitrarily complex conditions. The list of

        attributes which can be used in filter expressions is available

        in the x-filterable vendor extension.


        # Filter Expression Overview

        **Note: All keywords are case-insensitive**


        ## Comparison Operators

        | Operator | Description | Example |

        | --- | --- | --- |

        | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS ''foobar'', field4 CONTAINS TRUE  |

        | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN [''Goku'', ''Vegeta''] |

        | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 |

        | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 |

        | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 |

        | LT | Tests if a field is less than a literal value | field1 LT 9.02 |

        | NE | Tests if a field is not equal to a literal value | field1 NE 42 |

        | EQ | Tests if a field is equal to a literal value | field1 EQ 42 |


        ## Search Operator

        The SEARCH operator filters for items which have any filterable

        attribute that contains the input string as a substring, comparison

        is done case-insensitively. This is not restricted to attributes with

        string values. Specifically `SEARCH ''12''` would match an item with an

        attribute with an integer value of `123`.


        ## Logical Operators

        Ordered by precedence.

        | Operator | Description | Example |

        | --- | --- | --- |

        | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 |

        | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ ''Goku'' |

        | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ ''Goku'' |


        ## Grouping

        Parenthesis `()` can be used to override operator precedence.


        For example:

        NOT (field1 LT 1234 AND field2 CONTAINS ''foo'')


        ## Literal Values

        | Literal      | Description | Examples |

        | --- | --- | --- |

        | Nil | Represents the absence of a value | nil, Nil, nIl, NIL |

        | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE |

        | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 |

        | String | Single or double quoted | "foo", "bar", "foo bar", ''foo'', ''bar'', ''foo bar'' |

        | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 |

        | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], [''foo'', "bar"] |


        ## Limitations

        - A maximum of 8 unique identifiers may be used inside a filter expression.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SearchBody'
          examples:
            nested:
              description: 'An example of a nested Object comparison testing that at least one repository has a

                version which is equal to 19.0.0.

                '
              summary: Nested Object Comparison
              value:
                filter_expression: repositories CONTAINS {version eq '19.0.0'}
            relative:
              description: 'An example of a relative comparison testing that field1 has a

                value which is less than 123.

                '
              summary: Relative comparison
              value:
                filter_expression: field1 LE 123
            nil:
              description: 'An example of using nil to test for the absence of a value for field2.

                '
              summary: Absence of an attribute value
              value:
                filter_expression: field2 EQ NIL
            non-nil:
              description: 'An example of using nil to test for the existence of a value for field2.

                '
              summary: Existence of an attribute value
              value:
                filter_expression: field2 NE NIL
            contains:
              description: 'An example of using the ''CONTAINS'' operator to check if

                field2 contains the string ''foo''. If field2 is string valued

                then this is checking if ''foo'' is a substring of field2. If

                field2 is a list of strings then this is checking if ''foo''

                is a member of the list.

                '
              summary: Use of the CONTAINS operator
              value:
                filter_expression: field2 CONTAINS 'foo'
            in:
              description: 'An example of using the ''IN'' operator to check if field1

                is an element of a list literal.

                '
              summary: Use of the IN operator
              value:
                filter_expression: field1 IN [1, 2, 3]
            search:
              description: 'An example of using the ''SEARCH'' operator to retrieve all elements

                for which ''foo'' is a substring of a filterable attribute.

                '
              summary: Use of the SEARCH operator
              value:
                filter_expression: SEARCH 'foo'
            parenthesis:
              description: 'An example of parenthesis being used to group operators & override

                operator precedence.

                '
              summary: Overriding operator precedence
              value:
                filter_expression: field1 LT 1234 AND (field2 CONTAINS 'foo' OR field3 CONTAINS 'bar')
    DeleteTags:
      description: The parameters to delete tags
      content:
        application/json:
          schema:
            x-body-name: environment
            $ref: '#/components/schemas/DeleteTag'
          examples:
            delete_all_tags:
              description: Delete all tags for given object - No request body required
              summary: Delete all tags
              value: {}
            delete_tags_by_key:
              description: Delete all tags for given object with matching key
              summary: Delete tags by key
              value:
                key: key-1
            delete_tags_by_key_value:
              description: Delete tag for given object with matching key and value
              summary: Delete a tag by key & value
              value:
                key: key-1
                value: value-1
            delete_multiple_tags_by_key_value:
              description: Delete tags for given list of tags with matching key and value
              summary: Delete multiple tags by key & value
              value:
                tags:
                - key: key-1
                  value: value-1
                - key: key-2
                  value: value-2
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
      example: 50
      schema:
        type: integer
        minimum: 1
        maximum: 1000
        default: 100
    hookTemplatesSortParam:
      name: sort
      in: query
      description: The field to sort results by. A property name with a prepended '-' signifies a descending order.
      example: id
      required: false
      schema:
        type: string
        enum:
        - id
        - -id
        - name
        - -name
        - dct_managed
        - -dct_managed
        - engine_id
        - -engine_id
        nullable: true
        example: name
    cursor:
      name: cursor
      in: query
      description: Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.
      schema:
        type: string
        minLength: 1
        maxLength: 4096
    hookTemplateIdParam:
      in: path
      name: hookTemplateId
      required: true
      schema:
        type: string
        minLength: 1
      description: The ID of the Hook Template.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization