> ## Documentation Index > Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt > Use this file to discover all available pages before exploring further. # Deploy Job Preview ## OpenAPI ````yaml /openapi/openapi.json put /transforms/{transforms_id}/deploy-job-preview/{version_id} openapi: 3.1.0 info: title: Streamkap REST API description: >- The Streamkap REST API allows you to programmatically manage your CDC pipelines, sources, destinations, transforms, and more. Authenticate using a bearer token obtained from the [Access Token](/api-reference/auth/access-token) endpoint with your API client credentials. contact: name: Streamkap Support url: https://streamkap.com/ email: support@streamkap.com license: name: Proprietary version: 2.0.0 servers: - url: https://api.streamkap.com description: Production security: [] tags: - name: Alerts description: Manage alert subscribers, preferences, and notification credentials. - name: Authentication description: Obtain and refresh access tokens, manage client credentials and roles. - name: Billing description: Retrieve usage metrics, summaries, and export billing data. - name: Consumer Groups description: List, inspect, and reset Kafka consumer group offsets. - name: Dashboard description: Retrieve organisation-level statistics and overview data. - name: Destinations description: Create, configure, and manage data destinations and their lifecycle. - name: Kafka Access description: Manage Kafka users and their access permissions. - name: Logs description: Query and summarise system logs. - name: Pipelines description: Create, configure, and manage CDC pipelines and their lifecycle. - name: Project Keys description: Manage project keys that bundle API credentials and optional Kafka access. - name: Schema Registry description: Browse schema subjects, versions, and retrieve schema definitions. - name: Services description: View and switch service metadata. - name: Sources description: >- Create, configure, and manage data sources, snapshots, and their lifecycle. - name: Tags description: Create, update, and manage resource tags for organisation. - name: Topics description: Browse topic details, statistics, configurations, metrics, and messages. - name: Transforms description: >- Create, deploy, and manage data transforms, unit tests, and implementation details. paths: /transforms/{transforms_id}/deploy-job-preview/{version_id}: put: tags: - Transforms summary: Deploy Job Preview operationId: deployTransformPreview parameters: - name: transforms_id in: path required: true schema: type: string title: Transforms Id - name: version_id in: path required: true schema: type: string title: Version Id - name: replay_window in: query required: false schema: type: string default: '' title: Replay Window responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/TransformsMapFilterImplementation' - $ref: '#/components/schemas/TransformsEnrichAsyncImplementation' - $ref: '#/components/schemas/TransformsJoinImplementation' - $ref: '#/components/schemas/TransformsEnrichImplementation' - $ref: '#/components/schemas/TransformsTopicRouterImplementation' - type: 'null' title: Response Deploytransformpreview '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - FronteggHTTPAuthentication: [] components: schemas: TransformsMapFilterImplementation: properties: language: $ref: '#/components/schemas/TransformLanguageEnum' value_transform: type: string title: Value Transform key_transform: anyOf: - type: string - type: 'null' title: Key Transform topic_transform: anyOf: - type: string - type: 'null' title: Topic Transform common_transform: anyOf: - type: string - type: 'null' title: Common Transform value_schema_transform: anyOf: - type: string - type: 'null' title: Value Schema Transform key_schema_transform: anyOf: - type: string - type: 'null' title: Key Schema Transform unit_test: anyOf: - $ref: '#/components/schemas/TransformsUnitTest' - type: 'null' additionalProperties: false type: object required: - language - value_transform title: TransformsMapFilterImplementation TransformsEnrichAsyncImplementation: properties: language: $ref: '#/components/schemas/TransformLanguageEnum' value_transform: type: string title: Value Transform key_transform: anyOf: - type: string - type: 'null' title: Key Transform topic_transform: anyOf: - type: string - type: 'null' title: Topic Transform common_transform: anyOf: - type: string - type: 'null' title: Common Transform value_schema_transform: anyOf: - type: string - type: 'null' title: Value Schema Transform key_schema_transform: anyOf: - type: string - type: 'null' title: Key Schema Transform unit_test: anyOf: - $ref: '#/components/schemas/TransformsUnitTest' - type: 'null' async_timeout_ms: type: integer title: Async Timeout Ms default: 2000 async_capacity: type: integer title: Async Capacity default: 10 additionalProperties: false type: object required: - language - value_transform title: TransformsEnrichAsyncImplementation TransformsJoinImplementation: properties: inputTables: items: $ref: '#/components/schemas/TransformInputTable' type: array title: Inputtables joinSQL: type: string title: Joinsql keyFields: items: type: string type: array title: Keyfields stateTtlMs: anyOf: - type: string - type: 'null' title: Statettlms additionalProperties: false type: object required: - joinSQL title: TransformsJoinImplementation TransformsEnrichImplementation: properties: mainTable: $ref: '#/components/schemas/TransformInputTable' lookupTable: $ref: '#/components/schemas/TransformInputTable' enrichSQL: type: string title: Enrichsql additionalProperties: false type: object required: - mainTable - lookupTable - enrichSQL title: TransformsEnrichImplementation TransformsTopicRouterImplementation: properties: topic_prefix: type: string title: Topic Prefix description: Deprecated — kept for backwards compat with existing DB records default: '' kc_cluster_id: anyOf: - type: string - type: 'null' title: Kc Cluster Id description: KC cluster to deploy the connector to additionalProperties: false type: object title: TransformsTopicRouterImplementation description: >- Topic router transform — deployed as KC Kafka destination connector with byte passthrough. No Flink job. Uses ByteArrayConverter + RegexRouter SMT to rewrite topic names without deserializing message values. Input/output patterns come from transform.config (transforms.input.topic.pattern / transforms.output.topic.pattern). HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TransformLanguageEnum: type: string enum: - PYTHON - JAVASCRIPT - SQL title: TransformLanguageEnum TransformsUnitTest: properties: test_name: type: string title: Test Name input__json: items: $ref: '#/components/schemas/TransformsImplementationDetailsTestRecord' type: array title: Input Json output__json: items: $ref: '#/components/schemas/TransformsImplementationDetailsTestRecord' type: array title: Output Json result__json: anyOf: - items: $ref: '#/components/schemas/TransformsImplementationDetailsTestRecord' type: array - type: 'null' title: Result Json is_success: anyOf: - type: boolean - type: 'null' title: Is Success html_diff: anyOf: - type: string - type: 'null' title: Html Diff text_diff: anyOf: - type: string - type: 'null' title: Text Diff type: object required: - test_name - input__json - output__json title: TransformsUnitTest TransformInputTable: properties: name: type: string title: Name topicMatcherRegex: type: string title: Topicmatcherregex createTableSQL: anyOf: - type: string - type: 'null' title: Createtablesql additionalProperties: true type: object required: - name - topicMatcherRegex title: TransformInputTable ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError TransformsImplementationDetailsTestRecord: properties: topic: type: string title: Topic value: additionalProperties: true type: object title: Value key: anyOf: - additionalProperties: true type: object - type: 'null' title: Key timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp type: object required: - topic - value title: TransformsImplementationDetailsTestRecord securitySchemes: FronteggHTTPAuthentication: type: http scheme: bearer ````