openapi: 3.1.0 info: title: airbyte-api version: 1.0.0 description: Programmatically control Airbyte Cloud, OSS & Enterprise. servers: - url: https://api.airbyte.com/v1 description: Airbyte API v1 paths: /: get: tags: - public_root - public responses: '200': content: text/html: {} description: Redirects to documentation operationId: getDocumentation x-speakeasy-alias: getDocumentation summary: Airbyte Root Path, Currently Returns a Redirect to the Documentation security: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /health: get: tags: - public_health - public responses: '200': description: Successful operation operationId: getHealthCheck summary: Airbyte Health Check security: [] x-speakeasy-alias: getHealthCheck x-speakeasy-group: Health x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications: get: tags: - public_applications - public - Applications responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationReadList' examples: Application List Response Example: value: applications: - id: 780d5bd9-a8a0-43cf-8b35-cc2061ad8319 name: test application clientId: b6b159ce-07f4-4699-94b3-3e85b318852e clientSecret: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== createdAt: 1717969830000 description: List all Applications a User has permission to view. '403': description: Not allowed operationId: listApplications summary: Airbyte List Applications x-speakeasy-alias: listApplications x-speakeasy-group: Applications x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationCreate' examples: Application Creation Request Example: value: name: test application required: true tags: - public_applications - public - Applications responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationRead' examples: Application Creation Response Example: value: id: 780d5bd9-a8a0-43cf-8b35-cc2061ad8319 name: test application clientId: b6b159ce-07f4-4699-94b3-3e85b318852e clientSecret: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== createdAt: 1717969830000 description: Creates a new Application. '400': description: Invalid data '403': description: Not allowed operationId: createApplication summary: Airbyte Create an Application x-speakeasy-alias: createApplication x-speakeasy-group: Applications x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{applicationId}: get: tags: - public_applications - public - Applications responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationRead' examples: Application Get Response Example: value: id: 780d5bd9-a8a0-43cf-8b35-cc2061ad8319 name: test application clientId: b6b159ce-07f4-4699-94b3-3e85b318852e clientSecret: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== createdAt: 1717969830000 description: Get an Application by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getApplication x-speakeasy-alias: getApplication x-speakeasy-group: Applications summary: Airbyte Get an Application Detail x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_applications - public - Applications responses: '200': content: application/json: schema: $ref: '#/components/schemas/ApplicationRead' examples: Application Delete Response Example: value: id: 780d5bd9-a8a0-43cf-8b35-cc2061ad8319 name: test application clientId: b6b159ce-07f4-4699-94b3-3e85b318852e clientSecret: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== createdAt: 1717969830000 description: Delete an Application. '403': description: Not allowed '404': description: Not found operationId: deleteApplication x-speakeasy-alias: deleteApplication x-speakeasy-group: Applications summary: Airbyte Deletes an Application x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: applicationId schema: type: string in: path required: true /applications/token: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplicationTokenRequestWithGrant' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ApplicationTokenRequestWithGrant' examples: Application Token Request Example: value: clientId: 0da998a2-0d7b-49c7-bb6e-9f7eb9cc68a0 clientSecret: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== required: true tags: - public_applications - public - Applications responses: '200': content: application/json: schema: $ref: '#/components/schemas/PublicAccessTokenResponse' examples: Application Creation Response Example: value: access_token: TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQsIGNvbnNlY3RldHVyIGFkaXBpc2NpbmcgZWxpdC4gU2VkIGNvbmRpbWVudHVtIG5lYyBsaWJlcm8gc2VkIGxvYm9ydGlzLg== description: Creates an Access Token. '400': description: Invalid data '403': description: Not allowed operationId: createAccessToken summary: Airbyte Get an Access Token x-speakeasy-alias: createAccessToken x-speakeasy-group: Applications security: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /jobs: get: tags: - public_jobs - public - Jobs parameters: - name: connectionId description: Filter the Jobs by connectionId. schema: format: UUID type: string in: query required: false - name: limit description: Set the limit on the number of Jobs returned. The default is 20 Jobs. schema: format: int32 default: 20 maximum: 100 minimum: 1 type: integer in: query - name: offset description: Set the offset to start at when returning Jobs. The default is 0. schema: format: int32 default: 0 minimum: 0 type: integer in: query - name: jobType description: Filter the Jobs by jobType. schema: $ref: '#/components/schemas/JobTypeEnum' in: query - name: workspaceIds description: The UUIDs of the workspaces you wish to list jobs for. Empty list will retrieve all allowed workspaces. schema: type: array items: format: uuid type: string in: query required: false - name: status description: The Job status you want to filter by schema: $ref: '#/components/schemas/JobStatusEnum' in: query required: false - name: createdAtStart description: The start date to filter by schema: type: string format: date-time in: query required: false example: 1687450500000 - name: createdAtEnd description: The end date to filter by schema: type: string format: date-time in: query required: false example: 1687450500000 - name: updatedAtStart description: The start date to filter by schema: type: string format: date-time example: 1687450500000 in: query required: false - name: updatedAtEnd description: The end date to filter by schema: type: string format: date-time in: query required: false example: 1687450500000 - name: orderBy description: The field and method to use for ordering schema: type: string pattern: \w+|(ASC|DESC) in: query required: false example: updatedAt|DESC responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobsResponse' examples: Job List Response Example: value: next: https://api.airbyte.com/v1/jobs?limit=5&offset=10 previous: https://api.airbyte.com/v1/jobs?limit=5&offset=0 data: - id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 status: running jobType: sync description: List all the Jobs by connectionId. '403': description: Not allowed operationId: listJobs summary: Airbyte List Jobs by Sync Type x-speakeasy-alias: listJobs x-speakeasy-group: Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/JobCreateRequest' examples: Job Creation Request Example: value: connectionId: e735894a-e773-4938-969f-45f53957b75b jobType: sync required: true tags: - public_jobs - public - Jobs responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobResponse' examples: Job Creation Response Example: value: jobId: 1234 status: running jobType: sync description: Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for. '400': description: Invalid data '403': description: Not allowed operationId: createJob summary: Airbyte Trigger a Sync or Reset Job of a Connection x-speakeasy-alias: createJob x-speakeasy-group: Jobs x-microcks-operation: delay: 0 dispatcher: FALLBACK /jobs/{jobId}: get: tags: - public_jobs - public - Jobs responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobResponse' examples: Job Get Response Example: value: id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 status: running jobType: sync description: Get a Job by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getJob x-speakeasy-alias: getJob x-speakeasy-group: Jobs summary: Airbyte Get Job Status and Details x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_jobs - public - Jobs responses: '200': content: application/json: schema: $ref: '#/components/schemas/JobResponse' examples: cancelJob200Example: summary: Default cancelJob 200 response x-microcks-default: true value: jobId: abc123 status: pending jobType: sync startTime: example connectionId: abc123 lastUpdatedAt: example duration: example bytesSynced: 1 rowsSynced: 1 description: Cancel a Job. '403': description: Not allowed '404': description: Not found operationId: cancelJob x-speakeasy-alias: cancelJob x-speakeasy-group: Jobs summary: Airbyte Cancel a Running Job x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: jobId schema: format: int64 type: integer in: path required: true /regions: get: tags: - public_regions - public - Regions responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionsResponse' examples: listRegions200Example: summary: Default listRegions 200 response x-microcks-default: true value: data: example description: List all regions for the organization '403': description: Not allowed operationId: listRegions summary: Airbyte List Regions x-speakeasy-alias: listRegions x-speakeasy-group: Regions parameters: - name: organizationId description: The UUID of the organization to list regions for schema: type: string format: uuid in: query required: true x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/RegionCreateRequest' required: true tags: - public_regions - public - Regions responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionResponse' examples: createRegion200Example: summary: Default createRegion 200 response x-microcks-default: true value: regionId: abc123 name: example-name organizationId: abc123 enabled: true createdAt: example updatedAt: example description: Successfully created region '400': description: Invalid data '403': description: Not allowed operationId: createRegion summary: Airbyte Create a Region x-speakeasy-alias: createRegion x-speakeasy-group: Dataplanes x-microcks-operation: delay: 0 dispatcher: FALLBACK /regions/{regionId}: get: tags: - public_regions - public - Regions responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionResponse' examples: getRegion200Example: summary: Default getRegion 200 response x-microcks-default: true value: regionId: abc123 name: example-name organizationId: abc123 enabled: true createdAt: example updatedAt: example description: Get a region by the id in the path '403': description: Not allowed '404': description: Not found operationId: getRegion x-speakeasy-alias: getRegion x-speakeasy-group: Regions summary: Airbyte Get a Region x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: requestBody: content: application/json: schema: $ref: '#/components/schemas/RegionPatchRequest' required: true tags: - public_regions - public - Regions responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionResponse' examples: updateRegion200Example: summary: Default updateRegion 200 response x-microcks-default: true value: regionId: abc123 name: example-name organizationId: abc123 enabled: true createdAt: example updatedAt: example description: Successfully updated region '400': description: Invalid data '403': description: Not allowed '404': description: Not found operationId: updateRegion x-speakeasy-alias: updateRegion x-speakeasy-group: Dataplanes summary: Airbyte Update a Region x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_regions - public - Regions responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegionResponse' examples: deleteRegion200Example: summary: Default deleteRegion 200 response x-microcks-default: true value: regionId: abc123 name: example-name organizationId: abc123 enabled: true createdAt: example updatedAt: example description: Successfully deleted region '403': description: Not allowed '404': description: Not found operationId: deleteRegion x-speakeasy-alias: deleteRegion x-speakeasy-group: Regions summary: Airbyte Delete a Region x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: regionId schema: type: string format: uuid in: path required: true /dataplanes: get: tags: - public_dataplanes - public - Dataplanes responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataplanesResponse' examples: listDataplanes200Example: summary: Default listDataplanes 200 response x-microcks-default: true value: data: example description: List dataplanes accessible to the current user '403': description: Not allowed '404': description: Not found operationId: listDataplanes summary: Airbyte List Dataplanes x-speakeasy-alias: listDataplanes x-speakeasy-group: Dataplanes parameters: - name: regionIds description: The UUIDs of the regions to filter by. If provided, only dataplanes belonging to these regions will be returned. Empty list will retrieve all dataplanes accessible to the current user. schema: type: array items: format: uuid type: string in: query required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/DataplaneCreateRequest' required: true tags: - public_dataplanes - public - Dataplanes responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataplaneCreateResponseBody' examples: createDataplane200Example: summary: Default createDataplane 200 response x-microcks-default: true value: {} description: Successfully created dataplane '400': description: Invalid data '403': description: Not allowed '404': description: Not found operationId: createDataplane summary: Airbyte Create a Dataplane x-speakeasy-alias: createDataplane x-speakeasy-group: Dataplanes x-microcks-operation: delay: 0 dispatcher: FALLBACK /dataplanes/{dataplaneId}: get: tags: - public_dataplanes - public - Dataplanes responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataplaneResponse' examples: getDataplane200Example: summary: Default getDataplane 200 response x-microcks-default: true value: dataplaneId: abc123 name: example-name regionId: abc123 enabled: true createdAt: example updatedAt: example description: Get a dataplane by the id in the path '403': description: Not allowed '404': description: Not found operationId: getDataplane x-speakeasy-alias: getDataplane x-speakeasy-group: Dataplanes summary: Airbyte Get a Dataplane x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: requestBody: content: application/json: schema: $ref: '#/components/schemas/DataplanePatchRequest' required: true tags: - public_dataplanes - public - Dataplanes responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataplaneResponse' examples: updateDataplane200Example: summary: Default updateDataplane 200 response x-microcks-default: true value: dataplaneId: abc123 name: example-name regionId: abc123 enabled: true createdAt: example updatedAt: example description: Successfully updated dataplane '400': description: Invalid data '403': description: Not allowed '404': description: Not found operationId: updateDataplane x-speakeasy-alias: updateDataplane x-speakeasy-group: Dataplanes summary: Airbyte Update a Dataplane x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_dataplanes - public - Dataplanes responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataplaneResponse' examples: deleteDataplane200Example: summary: Default deleteDataplane 200 response x-microcks-default: true value: dataplaneId: abc123 name: example-name regionId: abc123 enabled: true createdAt: example updatedAt: example description: Successfully deleted dataplane '403': description: Not allowed '404': description: Not found operationId: deleteDataplane x-speakeasy-alias: deleteDataplane x-speakeasy-group: Dataplanes summary: Airbyte Delete a Dataplane x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: dataplaneId schema: type: string format: uuid in: path required: true /connector_definitions: get: tags: - public_connector_definitions - public - ConnectorDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectorDefinitionsResponse' examples: listConnectorDefinitions200Example: summary: Default listConnectorDefinitions 200 response x-microcks-default: true value: data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listConnectorDefinitions x-speakeasy-alias: listConnectorDefinitions x-speakeasy-group: ConnectorDefinitions summary: Airbyte List Connector Definitions parameters: - name: type description: The type of connector definition to list schema: $ref: '#/components/schemas/ConnectorType' in: query required: true - name: workspaceId description: The UUID of the workspace you wish to list connector definitions for. One of this or organizationId must be populated. schema: type: string format: uuid example: df08f6b0-b364-4cc1-9b3f-96f5d2fccfb2 in: query required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/declarative_sources: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true get: tags: - public_declarative_source_definitions - public - DeclarativeSourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeclarativeSourceDefinitionsResponse' examples: listDeclarativeSourceDefinitions200Example: summary: Default listDeclarativeSourceDefinitions 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listDeclarativeSourceDefinitions x-speakeasy-alias: listDeclarativeSourceDefinitions x-speakeasy-group: DeclarativeSourceDefinitions summary: Airbyte List Declarative Source Definitions. x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Airbyte Create a Declarative Source Definition. x-speakeasy-entity-operation: DeclarativeSourceDefinition#create operationId: createDeclarativeSourceDefinition x-speakeasy-alias: createDeclarativeSourceDefinition x-speakeasy-group: DeclarativeSourceDefinitions tags: - public_declarative_source_definitions - public - DeclarativeSourceDefinitions responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeclarativeSourceDefinitionResponse' examples: createDeclarativeSourceDefinition200Example: summary: Default createDeclarativeSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name manifest: example version: 1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDeclarativeSourceDefinitionRequest' x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/declarative_sources/{definitionId}: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true - name: definitionId x-speakeasy-match: id schema: format: uuid type: string in: path required: true get: tags: - public_declarative_source_definitions - public - DeclarativeSourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeclarativeSourceDefinitionResponse' examples: getDeclarativeSourceDefinition200Example: summary: Default getDeclarativeSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name manifest: example version: 1 description: Success '403': description: Not allowed '404': description: Not found operationId: getDeclarativeSourceDefinition x-speakeasy-alias: getDeclarativeSourceDefinition x-speakeasy-group: DeclarativeSourceDefinitions summary: Airbyte Get Declarative Source Definition Details. x-speakeasy-entity-operation: DeclarativeSourceDefinition#read x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - public_declarative_source_definitions - public - DeclarativeSourceDefinitions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDeclarativeSourceDefinitionRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeclarativeSourceDefinitionResponse' examples: updateDeclarativeSourceDefinition200Example: summary: Default updateDeclarativeSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name manifest: example version: 1 description: Success '403': description: Not allowed '404': description: Not found operationId: updateDeclarativeSourceDefinition x-speakeasy-alias: updateDeclarativeSourceDefinition x-speakeasy-group: DeclarativeSourceDefinitions summary: Airbyte Update Declarative Source Definition Details. x-speakeasy-entity-operation: DeclarativeSourceDefinition#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_declarative_source_definitions - public - DeclarativeSourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DeclarativeSourceDefinitionResponse' examples: deleteDeclarativeSourceDefinition200Example: summary: Default deleteDeclarativeSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name manifest: example version: 1 description: Success '403': description: Not allowed '404': description: Not found operationId: deleteDeclarativeSourceDefinition x-speakeasy-alias: deleteDeclarativeSourceDefinition x-speakeasy-group: DeclarativeSourceDefinitions summary: Airbyte Delete a Declarative Source Definition. x-speakeasy-entity-operation: DeclarativeSourceDefinition#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/sources: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true get: tags: - public_source_definitions - public - SourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionsResponse' examples: listSourceDefinitions200Example: summary: Default listSourceDefinitions 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listSourceDefinitions x-speakeasy-alias: listSourceDefinitions x-speakeasy-group: SourceDefinitions summary: Airbyte List Source Definitions. x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createSourceDefinition x-speakeasy-alias: createSourceDefinition x-speakeasy-group: SourceDefinitions summary: Airbyte Create a Source Definition. x-speakeasy-entity-operation: SourceDefinition#create tags: - public_source_definitions - public - SourceDefinitions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDefinitionRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: createSourceDefinition200Example: summary: Default createSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/sources/{definitionId}: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true - name: definitionId x-speakeasy-match: id schema: format: uuid type: string in: path required: true get: tags: - public_source_definitions - public - SourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: getSourceDefinition200Example: summary: Default getSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: getSourceDefinition x-speakeasy-alias: getSourceDefinition x-speakeasy-group: SourceDefinitions summary: Airbyte Get Source Definition Details. x-speakeasy-entity-operation: SourceDefinition#read x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - public_source_definitions - public - SourceDefinitions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDefinitionRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: updateSourceDefinition200Example: summary: Default updateSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: updateSourceDefinition x-speakeasy-alias: updateSourceDefinition x-speakeasy-group: SourceDefinitions summary: Airbyte Update Source Definition Details. x-speakeasy-entity-operation: SourceDefinition#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_source_definitions - public - SourceDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: deleteSourceDefinition200Example: summary: Default deleteSourceDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: deleteSourceDefinition x-speakeasy-alias: deleteSourceDefinition x-speakeasy-group: SourceDefinitions summary: Airbyte Delete a Source Definition. x-speakeasy-entity-operation: SourceDefinition#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/destinations: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true get: tags: - public_destination_definitions - public - DestinationDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionsResponse' examples: listDestinationDefinitions200Example: summary: Default listDestinationDefinitions 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listDestinationDefinitions x-speakeasy-alias: listDestinationDefinitions x-speakeasy-group: DestinationDefinitions summary: Airbyte List Destination Definitions. x-microcks-operation: delay: 0 dispatcher: FALLBACK post: operationId: createDestinationDefinition x-speakeasy-alias: createDestinationDefinition x-speakeasy-group: DestinationDefinitions summary: Airbyte Create a Destination Definition. x-speakeasy-entity-operation: DestinationDefinition#create tags: - public_destination_definitions - public - DestinationDefinitions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateDefinitionRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: createDestinationDefinition200Example: summary: Default createDestinationDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/definitions/destinations/{definitionId}: parameters: - name: workspaceId schema: format: uuid type: string in: path required: true - name: definitionId x-speakeasy-match: id schema: format: uuid type: string in: path required: true get: tags: - public_destination_definitions - public - DestinationDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: getDestinationDefinition200Example: summary: Default getDestinationDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: getDestinationDefinition x-speakeasy-alias: getDestinationDefinition x-speakeasy-group: DestinationDefinitions summary: Airbyte Get Destination Definition Details. x-speakeasy-entity-operation: DestinationDefinition#read x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - public_destination_definitions - public - DestinationDefinitions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDefinitionRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: updateDestinationDefinition200Example: summary: Default updateDestinationDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: updateDestinationDefinition x-speakeasy-alias: updateDestinationDefinition x-speakeasy-group: DestinationDefinitions summary: Airbyte Update Destination Definition Details. x-speakeasy-entity-operation: DestinationDefinition#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_destination_definitions - public - DestinationDefinitions responses: '200': content: application/json: schema: $ref: '#/components/schemas/DefinitionResponse' examples: deleteDestinationDefinition200Example: summary: Default deleteDestinationDefinition 200 response x-microcks-default: true value: id: abc123 name: example-name dockerRepository: example dockerImageTag: example documentationUrl: https://example.com description: Success '403': description: Not allowed '404': description: Not found operationId: deleteDestinationDefinition x-speakeasy-alias: deleteDestinationDefinition x-speakeasy-group: DestinationDefinitions summary: Airbyte Delete a Destination Definition. x-speakeasy-entity-operation: DestinationDefinition#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK /sources: get: tags: - public_sources - public - Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourcesResponse' examples: listSources200Example: summary: Default listSources 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listSources x-speakeasy-alias: listSources x-speakeasy-group: Sources summary: Airbyte List Sources parameters: - name: workspaceIds description: The UUIDs of the workspaces you wish to list sources for. Empty list will retrieve all allowed workspaces. schema: type: array items: format: uuid type: string example: df08f6b0-b364-4cc1-9b3f-96f5d2fccfb2,b0796797-de23-4fc7-a5e2-7e131314718c in: query required: false - name: includeDeleted description: Include deleted sources in the returned results. schema: default: false type: boolean in: query required: false - name: limit description: Set the limit on the number of sources returned. The default is 20. schema: format: int32 type: integer minimum: 1 maximum: 100 default: 20 in: query - name: offset description: Set the offset to start at when returning sources. The default is 0 schema: type: integer format: int32 minimum: 0 default: 0 in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/SourceCreateRequest' examples: Source Creation Request Example: value: configuration: airbyte_source_name: google-ads conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 name: My Source workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 tags: - public_sources - public - Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourceResponse' examples: Source Creation Response Example: value: sourceId: 0c31738c-0b2d-4887-b506-e2cd1c39cc35 description: Successful operation '400': description: Invalid data '403': description: Not allowed operationId: createSource x-speakeasy-alias: createSource x-speakeasy-group: Sources x-speakeasy-entity-operation: Source#create summary: Airbyte Create a Source description: Creates a source given a name, workspace id, and a json blob containing the configuration for the source. x-microcks-operation: delay: 0 dispatcher: FALLBACK /sources/{sourceId}: get: tags: - public_sources - public - Sources responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourceResponse' examples: Source Get Response Example: value: sourceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: running sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 description: Get a Source by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getSource x-speakeasy-alias: getSource x-speakeasy-group: Sources x-speakeasy-entity-operation: Source#read summary: Airbyte Get Source Details parameters: - in: query name: includeSecretCoordinates schema: type: boolean required: false description: Rather than return *** for secret properties include the secret coordinate information x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_sources - public - Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/SourcePatchRequest' examples: Source Update Request Example: value: configuration: airbyte_source_name: google-ads conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 name: My Source workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourceResponse' examples: Source Update Response Example: value: sourceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: running sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 description: Update a Source '403': description: Not allowed '404': description: Not found operationId: patchSource x-speakeasy-alias: patchSource x-speakeasy-group: Sources summary: Airbyte Update a Source x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - public_sources - public - Sources requestBody: content: application/json: schema: $ref: '#/components/schemas/SourcePutRequest' examples: Source Update Request Example: value: configuration: airbyte_source_name: google-ads conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 name: My Source workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 responses: '200': content: application/json: schema: $ref: '#/components/schemas/SourceResponse' examples: Source Update Response Example: value: sourceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: running sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 description: Update a source and fully overwrite it '403': description: Not allowed '404': description: Not found operationId: putSource x-speakeasy-alias: putSource x-speakeasy-group: Sources summary: Airbyte Update a Source and Fully Overwrite it x-speakeasy-entity-operation: Source#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_sources - public - Sources responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteSource x-speakeasy-alias: deleteSource x-speakeasy-group: Sources summary: Airbyte Delete a Source x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: sourceId schema: format: UUID type: string in: path required: true /destinations: get: tags: - public_destinations - public - Destinations responses: '200': content: application/json: schema: $ref: '#/components/schemas/DestinationsResponse' examples: listDestinations200Example: summary: Default listDestinations 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listDestinations x-speakeasy-alias: listDestinations x-speakeasy-group: Destinations summary: Airbyte List Destinations parameters: - name: workspaceIds description: The UUIDs of the workspaces you wish to list destinations for. Empty list will retrieve all allowed workspaces. schema: type: array items: format: uuid type: string in: query required: false - name: includeDeleted description: Include deleted destinations in the returned results. schema: default: false type: boolean in: query required: false - name: limit description: Set the limit on the number of destinations returned. The default is 20. schema: format: int32 type: integer minimum: 1 maximum: 100 default: 20 in: query - name: offset description: Set the offset to start at when returning destinations. The default is 0 schema: type: integer format: int32 minimum: 0 default: 0 in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK post: requestBody: content: application/json: schema: $ref: '#/components/schemas/DestinationCreateRequest' examples: Destination Creation Request Example: value: name: Postgres workspaceId: 2155ae5a-de39-4808-af6a-16fe7b8b4ed2 configuration: airbyte_destination_name: postgres port: 5432 schema: public ssl_mode: mode: prefer tunnel_method: tunnel_method: NO_TUNNEL host: localhost database: postgres username: postgres password: test tags: - public_destinations - public - Destinations responses: '200': content: application/json: schema: $ref: '#/components/schemas/DestinationResponse' examples: Destination Creation Response Example: value: destinationId: af0c3c67-aa61-419f-8922-95b0bf840e86 description: Successful operation '400': description: Invalid data '403': description: Not allowed '404': description: Not found operationId: createDestination x-speakeasy-alias: createDestination x-speakeasy-entity-operation: Destination#create x-speakeasy-group: Destinations summary: Airbyte Create a Destination description: Creates a destination given a name, workspace id, and a json blob containing the configuration for the source. x-microcks-operation: delay: 0 dispatcher: FALLBACK /destinations/{destinationId}: get: tags: - public_destinations - public - Destinations responses: '200': content: application/json: schema: $ref: '#/components/schemas/DestinationResponse' examples: Destination Get Response Example: value: destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: My Destination sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 configuration: conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 description: Get a Destination by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getDestination x-speakeasy-alias: getDestination x-speakeasy-entity-operation: Destination#read x-speakeasy-group: Destinations summary: Airbyte Get Destination Details parameters: - in: query name: includeSecretCoordinates schema: type: boolean required: false description: Rather than return *** for secret properties include the secret coordinate information x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_destinations - public - Destinations responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteDestination x-speakeasy-alias: deleteDestination x-speakeasy-entity-operation: Destination#delete x-speakeasy-group: Destinations summary: Airbyte Delete a Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_destinations - public - Destinations requestBody: content: application/json: schema: $ref: '#/components/schemas/DestinationPatchRequest' examples: Destination Update Request Example: value: configuration: conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 name: My Destination responses: '200': content: application/json: schema: $ref: '#/components/schemas/DestinationResponse' examples: Destination Update Response Example: value: destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: running sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 configuration: conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 description: Update a Destination '403': description: Not allowed '404': description: Not found operationId: patchDestination x-speakeasy-alias: patchDestination x-speakeasy-group: Destinations summary: Airbyte Update a Destination x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - public_destinations - public - Destinations requestBody: content: application/json: schema: $ref: '#/components/schemas/DestinationPutRequest' examples: Destination Update Request Example: value: configuration: conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 name: My Destination responses: '200': content: application/json: schema: $ref: '#/components/schemas/DestinationResponse' examples: Destination Update Response Example: value: destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: running sourceType: postgres workspaceId: 744cc0ed-7f05-4949-9e60-2a814f90c035 configuration: conversion_window_days: 14 customer_id: '1234567890' start_date: 1672531200000 end_date: 1704067200000 description: Update a Destination and fully overwrite it '403': description: Not allowed '404': description: Not found operationId: putDestination x-speakeasy-alias: putDestination x-speakeasy-group: Destinations x-speakeasy-entity-operation: Destination#update summary: Airbyte Update a Destination and Fully Overwrite it x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: destinationId schema: format: UUID type: string in: path required: true /oauth/callback: get: tags: - public_oauth - public - OAuth parameters: - name: queryParams description: Query parameters. Should contain state and code. required: false schema: type: object additionalProperties: type: string in: query responses: '302': description: Redirect to the URL requested in the initiate call with the created secret ID. operationId: oauthCallback x-speakeasy-alias: oauthCallback x-speakeasy-group: OAuth summary: Airbyte Receive OAuth Callbacks description: Redirected to by identity providers after authentication. security: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /sources/initiateOAuth: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateOauthRequest' required: true tags: - public_sources - public - Sources responses: '200': $ref: '#/components/responses/InitiateOauthResponse' '400': description: A field in the body has not been set appropriately. '403': description: API key is invalid. operationId: initiateOAuth x-speakeasy-alias: initiateOAuth x-speakeasy-group: Sources summary: Airbyte Initiate OAuth for a Source description: |- Given a source ID, workspace ID, and redirect URL, initiates OAuth for the source. This returns a fully formed URL for performing user authentication against the relevant source identity provider (IdP). Once authentication has been completed, the IdP will redirect to an Airbyte endpoint which will save the access and refresh tokens off as a secret and return the secret ID to the redirect URL specified in the `secret_id` query string parameter. That secret ID can be used to create a source with credentials in place of actual tokens. x-microcks-operation: delay: 0 dispatcher: FALLBACK /connections: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionCreateRequest' examples: Connection Creation Request Example: value: sourceId: 95e66a59-8045-4307-9678-63bc3c9b8c93 destinationId: e478de0d-a3a0-475c-b019-25f7dd29e281 name: Postgres-to-Bigquery required: true tags: - public_connections - public - Connections responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' examples: Connection Creation Response Example: value: connectionId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 description: Successful operation '400': description: Invalid data '403': description: Not allowed operationId: createConnection x-speakeasy-alias: createConnection x-speakeasy-group: Connections summary: Airbyte Create a Connection x-speakeasy-entity-operation: Connection#create x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - public_connections - public - Connections responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionsResponse' examples: listConnections200Example: summary: Default listConnections 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listConnections x-speakeasy-alias: listConnections x-speakeasy-group: Connections summary: Airbyte List Connections x-speakeasy-entity-operation: Connections#read parameters: - name: workspaceIds description: The UUIDs of the workspaces you wish to list connections for. Empty list will retrieve all allowed workspaces. schema: type: array items: format: uuid type: string in: query required: false - name: tagIds description: The UUIDs of the tags you wish to list connections for. Empty list will retrieve all connections. schema: type: array items: format: uuid type: string in: query required: false - name: includeDeleted description: Include deleted connections in the returned results. schema: default: false type: boolean in: query required: false - name: limit description: Set the limit on the number of Connections returned. The default is 20. schema: format: int32 type: integer minimum: 1 maximum: 100 default: 20 in: query - name: offset description: Set the offset to start at when returning Connections. The default is 0 schema: type: integer format: int32 minimum: 0 default: 0 in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK /connections/{connectionId}: get: tags: - public_connections - public - Connections responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' examples: Connection Get Response Example: value: workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Postgres To Snowflake sourceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 destinationId: 744cc0ed-7f05-4949-9e60-2a814f90c035 description: Get a Connection by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getConnection x-speakeasy-alias: getConnection x-speakeasy-group: Connections summary: Airbyte Get Connection Details x-speakeasy-entity-operation: Connection#read x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_connections - public - Connections requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectionPatchRequest' examples: Connection Update Request Example: value: sourceId: 95e66a59-8045-4307-9678-63bc3c9b8c93 destinationId: e478de0d-a3a0-475c-b019-25f7dd29e281 name: Postgres-to-Bigquery required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionResponse' examples: Connection Get Response Example: value: workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Postgres To Snowflake sourceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 destinationId: 744cc0ed-7f05-4949-9e60-2a814f90c035 description: Update a Connection by the id in the path. '403': description: Not allowed '404': description: Not found operationId: patchConnection x-speakeasy-alias: patchConnection x-speakeasy-group: Connections summary: Airbyte Update Connection Details x-speakeasy-entity-operation: Connection#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_connections - public - Connections responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteConnection x-speakeasy-alias: deleteConnection x-speakeasy-group: Connections summary: Airbyte Delete a Connection x-speakeasy-entity-operation: Connection#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: connectionId schema: format: UUID type: string in: path required: true /streams: get: tags: - public_streams - public - Streams responses: '200': content: application/json: schema: $ref: '#/components/schemas/StreamPropertiesResponse' examples: getStreamProperties200Example: summary: Default getStreamProperties 200 response x-microcks-default: true value: - streamName: example-name syncModes: example streamnamespace: example-name defaultCursorField: example sourceDefinedCursorField: true sourceDefinedPrimaryKey: example propertyFields: example description: Get the available streams properties for a source/destination pair. '400': description: Required parameters are missing '403': description: Not allowed '404': description: Not found operationId: getStreamProperties x-speakeasy-alias: getStreamProperties x-speakeasy-group: Streams summary: Airbyte Get Stream Properties parameters: - name: sourceId description: ID of the source schema: format: UUID type: string in: query required: true - name: destinationId description: ID of the destination schema: format: UUID type: string in: query required: false - name: ignoreCache description: If true pull the latest schema from the source, else pull from cache (default false) schema: type: boolean default: false in: query required: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces: get: tags: - public_workspaces - public - Workspaces responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspacesResponse' examples: listWorkspaces200Example: summary: Default listWorkspaces 200 response x-microcks-default: true value: previous: example next: example data: example description: Successful operation '403': description: Not allowed '404': description: Not found operationId: listWorkspaces x-speakeasy-alias: listWorkspaces x-speakeasy-group: Workspaces summary: Airbyte List Workspaces parameters: - name: workspaceIds description: The UUIDs of the workspaces you wish to fetch. Empty list will retrieve all allowed workspaces. schema: type: array items: format: uuid type: string in: query required: false - name: includeDeleted description: Include deleted workspaces in the returned results. schema: default: false type: boolean in: query required: false - name: limit description: Set the limit on the number of workspaces returned. The default is 20. schema: format: int32 type: integer minimum: 1 maximum: 100 default: 20 in: query - name: offset description: Set the offset to start at when returning workspaces. The default is 0 schema: type: integer format: int32 minimum: 0 default: 0 in: query x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_workspaces - public - Workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkspaceCreateRequest' examples: Workspace Creation Request Example: value: name: Company Workspace Name required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspaceResponse' examples: Workspace Creation Response Example: value: workspaceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 description: Successful operation '400': description: Invalid data '403': description: Not allowed operationId: createWorkspace x-speakeasy-alias: createWorkspace x-speakeasy-group: Workspaces summary: Airbyte Create a Workspace x-speakeasy-entity-operation: Workspace#create x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}: parameters: - name: workspaceId schema: format: UUID type: string in: path required: true get: tags: - public_workspaces - public - Workspaces responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspaceResponse' examples: Workspace Get Response Example: value: workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Acme Company dataResidency: auto description: Get a Workspace by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getWorkspace x-speakeasy-alias: getWorkspace x-speakeasy-group: Workspaces summary: Airbyte Get Workspace Details x-speakeasy-entity-operation: Workspace#read x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_workspaces - public - Workspaces requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkspaceUpdateRequest' examples: Workspace Update Request Example: value: name: Company Workspace Name required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkspaceResponse' examples: Workspace Update Response Example: value: workspaceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 description: Successful operation '400': description: Invalid data '403': description: Not allowed operationId: updateWorkspace x-speakeasy-alias: updateWorkspace x-speakeasy-group: Workspaces summary: Airbyte Update a Workspace x-speakeasy-entity-operation: Workspace#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_workspaces - public - Workspaces responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteWorkspace x-speakeasy-alias: deleteWorkspace x-speakeasy-group: Workspaces summary: Airbyte Delete a Workspace x-speakeasy-entity-operation: Workspace#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK /workspaces/{workspaceId}/oauthCredentials: put: requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkspaceOAuthCredentialsRequest' required: true tags: - public_workspaces - public - Workspaces responses: '200': description: OAuth credential override was successful. '400': description: A field in the body has not been set appropriately. '403': description: API key is invalid. operationId: createOrUpdateWorkspaceOAuthCredentials x-speakeasy-alias: createOrUpdateWorkspaceOAuthCredentials x-speakeasy-group: Workspaces summary: Airbyte Create OAuth Override Credentials for a Workspace and Source Type. description: |- Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination. x-microcks-operation: delay: 0 dispatcher: FALLBACK parameters: - name: workspaceId schema: format: UUID type: string in: path required: true /permissions/{permissionId}: parameters: - name: permissionId schema: format: UUID type: string in: path required: true get: tags: - public_permissions - public - Permissions responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionResponse' examples: getPermission200Example: summary: Default getPermission 200 response x-microcks-default: true value: permissionId: abc123 permissionType: instance_admin userId: abc123 workspaceId: abc123 organizationId: abc123 description: Get a Permission by the id in the path. '403': description: Not allowed '404': description: Not found '422': description: Data issue operationId: getPermission summary: Airbyte Get Permission Details x-speakeasy-alias: getPermission x-speakeasy-group: Permissions x-speakeasy-entity-operation: Permission#read x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_permissions - public - Permissions requestBody: content: application/json: schema: $ref: '#/components/schemas/PermissionUpdateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionResponse' examples: updatePermission200Example: summary: Default updatePermission 200 response x-microcks-default: true value: permissionId: abc123 permissionType: instance_admin userId: abc123 workspaceId: abc123 organizationId: abc123 description: Successful updated '400': description: Invalid data '403': description: Not allowed '404': description: Not found '422': description: Data issue operationId: updatePermission summary: Airbyte Update a Permission x-speakeasy-alias: updatePermission x-speakeasy-group: Permissions x-speakeasy-entity-operation: Permission#update x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_permissions - public - Permissions responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found '422': description: Data issue operationId: deletePermission x-speakeasy-alias: deletePermission x-speakeasy-group: Permissions summary: Airbyte Delete a Permission x-speakeasy-entity-operation: Permission#delete x-microcks-operation: delay: 0 dispatcher: FALLBACK /permissions: get: tags: - public_permissions - public - Permissions parameters: - name: userId description: User Id in permission. schema: format: UUID type: string in: query required: false - name: organizationId description: This is required if you want to read someone else's permissions, and you should have organization admin or a higher role. schema: format: UUID type: string in: query required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionsResponse' examples: listPermissions200Example: summary: Default listPermissions 200 response x-microcks-default: true value: data: example description: List Permissions. '403': description: Not allowed '404': description: Not found operationId: listPermissions x-speakeasy-alias: listPermissions x-speakeasy-group: Permissions summary: Airbyte List Permissions by User Id x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_permissions - public - Permissions requestBody: content: application/json: schema: $ref: '#/components/schemas/PermissionCreateRequest' examples: Permission Creation Request Example: value: permissionType: workspace_admin userId: 7d08fd6c-531e-4a00-937e-3d355f253e63 workspaceId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PermissionResponse' examples: Permission Creation Response Example: value: permissionId: 9924bcd0-99be-453d-ba47-c2c9766f7da5 permissionType: workspace_admin userId: 7d08fd6c-531e-4a00-937e-3d355f253e63 description: Successful operation '400': description: Invalid data '403': description: Not allowed operationId: createPermission x-speakeasy-alias: createPermission x-speakeasy-group: Permissions summary: Airbyte Create a Permission x-speakeasy-entity-operation: Permission#create x-microcks-operation: delay: 0 dispatcher: FALLBACK /organizations: get: tags: - public_organizations - public - Organizations summary: Airbyte List All Organizations for a User description: Lists users organizations. responses: '200': content: application/json: schema: $ref: '#/components/schemas/OrganizationsResponse' examples: listOrganizationsForUser200Example: summary: Default listOrganizationsForUser 200 response x-microcks-default: true value: data: example description: List user's organizations. '403': description: Not allowed '404': description: Not found operationId: listOrganizationsForUser x-speakeasy-alias: listOrganizationsForUser x-speakeasy-group: Organizations x-microcks-operation: delay: 0 dispatcher: FALLBACK /organizations/{organizationId}/oauthCredentials: put: parameters: - name: organizationId schema: format: UUID type: string in: path required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationOAuthCredentialsRequest' required: true tags: - public_organizations - public - Organizations responses: '200': description: OAuth credential override was successful. '400': description: A field in the body has not been set appropriately. '403': description: API key is invalid. operationId: createOrUpdateOrganizationOAuthCredentials x-speakeasy-alias: createOrUpdateOrganizationOAuthCredentials x-speakeasy-group: Organizations summary: Airbyte Create OAuth Override Credentials for an Organization and Source Type. description: |- Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination. x-microcks-operation: delay: 0 dispatcher: FALLBACK /organizations/{organizationId}/oauthCredentials/{actorType}/{name}: delete: parameters: - name: organizationId schema: format: UUID type: string in: path required: true - name: actorType schema: $ref: '#/components/schemas/ActorTypeEnum' in: path required: true - name: name schema: type: string in: path required: true description: The name of the source or destination i.e. google-ads tags: - public_organizations - public - Organizations responses: '204': description: OAuth credential override was deleted successfully. '400': description: A field in the path has not been set appropriately. '403': description: API key is invalid. operationId: deleteOrganizationOAuthCredentials x-speakeasy-alias: deleteOrganizationOAuthCredentials x-speakeasy-group: Organizations summary: Airbyte Delete OAuth Override Credentials for an Organization and Source/destination Type. description: |- Delete a set of OAuth credentials that overrides the Airbyte-provided OAuth credentials used for source/destination OAuth. x-microcks-operation: delay: 0 dispatcher: FALLBACK /users: get: tags: - public_users - public - Users summary: Airbyte List All Users Within an Organization description: Organization Admin user can list all users within the same organization. Also provide filtering on a list of user IDs or/and a list of user emails. parameters: - in: query name: organizationId schema: type: string format: UUID required: true - in: query name: ids schema: type: array items: type: string format: UUID description: List of user IDs to filter by - in: query name: emails schema: type: array items: type: string format: email description: List of user emails to filter by responses: '200': content: application/json: schema: $ref: '#/components/schemas/UsersResponse' examples: listUsersWithinAnOrganization200Example: summary: Default listUsersWithinAnOrganization 200 response x-microcks-default: true value: data: example description: List Users. '403': description: Not allowed '404': description: Not found operationId: listUsersWithinAnOrganization x-speakeasy-alias: listUsersWithinAnOrganization x-speakeasy-group: Users x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups: get: tags: - public_groups - public - Groups summary: Airbyte List Groups description: List all groups within the specified organization parameters: - name: organizationId in: query description: Filter groups by organization ID required: true schema: type: string format: uuid - name: limit description: Set the limit on the number of Groups returned. The default is 20 Groups. schema: format: int32 default: 20 maximum: 100 minimum: 1 type: integer in: query - name: offset description: Set the offset to start at when returning Groups. The default is 0. schema: format: int32 default: 0 minimum: 0 type: integer in: query responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupsResponse' examples: listGroups200Example: summary: Default listGroups 200 response x-microcks-default: true value: data: example next: example previous: example description: List Groups. '403': description: Not allowed '404': description: Not found operationId: listGroups x-speakeasy-alias: listGroups x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_groups - public - Groups summary: Airbyte Create Group description: Create a new group within an organization requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupCreateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupResponse' examples: createGroup200Example: summary: Default createGroup 200 response x-microcks-default: true value: groupId: abc123 name: example-name description: Example description organizationId: abc123 memberCount: 1 description: Group created successfully. '400': description: Invalid input '403': description: Not allowed '409': description: Group with this name already exists in the organization operationId: createGroup x-speakeasy-alias: createGroup x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups/{groupId}: parameters: - name: groupId in: path required: true description: Group identifier schema: type: string format: uuid get: tags: - public_groups - public - Groups summary: Airbyte Get Group Details description: Get a specific group by ID responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupResponse' examples: getGroup200Example: summary: Default getGroup 200 response x-microcks-default: true value: groupId: abc123 name: example-name description: Example description organizationId: abc123 memberCount: 1 description: Get a Group by the id in the path. '403': description: Not allowed '404': description: Not found operationId: getGroup x-speakeasy-alias: getGroup x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_groups - public - Groups summary: Airbyte Update Group description: Update an existing group requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupResponse' examples: updateGroup200Example: summary: Default updateGroup 200 response x-microcks-default: true value: groupId: abc123 name: example-name description: Example description organizationId: abc123 memberCount: 1 description: Group updated successfully. '400': description: Invalid input '403': description: Not allowed '404': description: Not found '409': description: Group name conflict operationId: updateGroup x-speakeasy-alias: updateGroup x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_groups - public - Groups summary: Airbyte Delete Group description: Delete a group and remove all associated memberships responses: '204': description: Group deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteGroup x-speakeasy-alias: deleteGroup x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups/{groupId}/members: parameters: - name: groupId in: path required: true description: Group identifier schema: type: string format: uuid get: tags: - public_group_members - public - Groups summary: Airbyte List Group Members description: Get all members of a specific group parameters: - name: limit description: Set the limit on the number of members returned. The default is 20. schema: format: int32 default: 20 maximum: 100 minimum: 1 type: integer in: query - name: offset description: Set the offset to start at when returning members. The default is 0. schema: format: int32 default: 0 minimum: 0 type: integer in: query responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupMembersResponse' examples: listGroupMembers200Example: summary: Default listGroupMembers 200 response x-microcks-default: true value: data: example next: example previous: example description: List Group members. '403': description: Not allowed '404': description: Not found operationId: listGroupMembers x-speakeasy-alias: listGroupMembers x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_group_members - public - Groups summary: Airbyte Add Member to Group description: Add a user to a group requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupMemberAddRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupMemberResponse' examples: addGroupMember201Example: summary: Default addGroupMember 201 response x-microcks-default: true value: memberId: abc123 groupId: abc123 userId: abc123 userEmail: user@example.com userName: example-name description: Member added successfully. '400': description: Invalid input '403': description: Not allowed '404': description: Not found '409': description: User is already a member of this group operationId: addGroupMember x-speakeasy-alias: addGroupMember x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups/{groupId}/members/{userId}: parameters: - name: groupId in: path required: true description: Group identifier schema: type: string format: uuid - name: userId in: path required: true description: User identifier schema: type: string format: uuid delete: tags: - public_group_members - public - Groups summary: Airbyte Remove Member from Group description: Remove a user from a group responses: '204': description: Member removed successfully '403': description: Not allowed '404': description: Not found operationId: removeGroupMember x-speakeasy-alias: removeGroupMember x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups/{groupId}/permissions: parameters: - name: groupId in: path required: true description: Group identifier schema: type: string format: uuid get: tags: - public_group_permissions - public - Groups summary: Airbyte List Group Permissions description: Get all permissions assigned to a group responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupPermissionsResponse' examples: listGroupPermissions200Example: summary: Default listGroupPermissions 200 response x-microcks-default: true value: data: example description: List Group permissions. '403': description: Not allowed '404': description: Not found operationId: listGroupPermissions x-speakeasy-alias: listGroupPermissions x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_group_permissions - public - Groups summary: Airbyte Create Group Permission description: Assign a permission to a group requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupPermissionCreateRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/GroupPermissionResponse' examples: createGroupPermission201Example: summary: Default createGroupPermission 201 response x-microcks-default: true value: permissionId: abc123 groupId: abc123 permissionType: instance_admin workspaceId: abc123 organizationId: abc123 description: Permission created successfully. '400': description: Invalid input '403': description: Not allowed '404': description: Not found '409': description: Permission already exists for this group operationId: createGroupPermission x-speakeasy-alias: createGroupPermission x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /groups/{groupId}/permissions/{permissionId}: parameters: - name: groupId in: path required: true description: Group identifier schema: type: string format: uuid - name: permissionId in: path required: true description: Permission identifier schema: type: string format: uuid delete: tags: - public_group_permissions - public - Groups summary: Airbyte Delete Group Permission description: Remove a permission from a group responses: '204': description: Permission deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteGroupPermission x-speakeasy-alias: deleteGroupPermission x-speakeasy-group: Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags: get: tags: - public_tags - public - Tags summary: Airbyte List All Tags description: Lists all tags parameters: - name: workspaceIds in: query schema: type: array items: format: uuid type: string required: false responses: '200': content: application/json: schema: $ref: '#/components/schemas/TagsResponse' examples: listTags200Example: summary: Default listTags 200 response x-microcks-default: true value: data: example description: List Tags. '403': description: Not allowed '404': description: Not found operationId: listTags x-speakeasy-alias: listTags x-speakeasy-group: Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - public_tags - public - Tags summary: Airbyte Create a Tag description: Create a tag requestBody: content: application/json: schema: $ref: '#/components/schemas/TagCreateRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TagResponse' examples: createTag200Example: summary: Default createTag 200 response x-microcks-default: true value: tagId: abc123 name: example-name color: example workspaceId: abc123 description: Successful operation '400': description: Invalid data '403': description: Not allowed '409': description: Tag with same name already exists operationId: createTag x-speakeasy-alias: createTag x-speakeasy-group: Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK /tags/{tagId}: parameters: - name: tagId schema: $ref: '#/components/schemas/TagId' in: path required: true get: tags: - public_tags - public - Tags summary: Airbyte Get a Tag description: Get a tag responses: '200': content: application/json: schema: $ref: '#/components/schemas/TagResponse' examples: getTag200Example: summary: Default getTag 200 response x-microcks-default: true value: tagId: abc123 name: example-name color: example workspaceId: abc123 description: Successful operation '403': description: Not allowed '404': description: Not found operationId: getTag x-speakeasy-alias: getTag x-speakeasy-group: Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - public_tags - public - Tags summary: Airbyte Delete a Tag description: Delete a tag responses: '204': description: The resource was deleted successfully '403': description: Not allowed '404': description: Not found operationId: deleteTag x-speakeasy-alias: deleteTag x-speakeasy-group: Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - public_tags - public - Tags summary: Airbyte Update a Tag description: Update a tag requestBody: content: application/json: schema: $ref: '#/components/schemas/TagPatchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TagResponse' examples: updateTag200Example: summary: Default updateTag 200 response x-microcks-default: true value: tagId: abc123 name: example-name color: example workspaceId: abc123 description: Successful operation '400': description: Invalid data '403': description: Not allowed '404': description: Not found operationId: updateTag x-speakeasy-alias: updateTag x-speakeasy-group: Tags x-microcks-operation: delay: 0 dispatcher: FALLBACK /embedded/widget_token: post: description: Get a token for the embedded widget. This endpoint is only available when Airbyte Embedded is enabled. operationId: getEmbeddedWidget x-speakeasy-alias: getEmbeddedWidget x-speakeasy-group: EmbeddedWidget summary: Airbyte Get a Widget Token for Airbyte Embedded requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddedWidgetRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddedWidgetResponse' examples: getEmbeddedWidget200Example: summary: Default getEmbeddedWidget 200 response x-microcks-default: true value: token: example description: Success tags: - public - embedded_widget x-microcks-operation: delay: 0 dispatcher: FALLBACK /embedded/scoped_token: post: description: Generate a token scoped to an end-user workspace. operationId: generateEmbeddedScopedToken x-speakeasy-alias: generateEmbeddedScopedToken x-speakeasy-group: EmbeddedScopedToken summary: Airbyte Generate a Scoped Token for Airbyte Embedded requestBody: content: application/json: schema: $ref: '#/components/schemas/EmbeddedScopedTokenRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/EmbeddedScopedTokenResponse' examples: generateEmbeddedScopedToken200Example: summary: Default generateEmbeddedScopedToken 200 response x-microcks-default: true value: token: example description: Success tags: - public - embedded_widget x-microcks-operation: delay: 0 dispatcher: FALLBACK /embedded/organizations: get: summary: Airbyte List Organizations That a User Has Access to That Have Embedded Enabled. tags: - public - embedded_widget operationId: listEmbeddedOrganizationsByUser x-speakeasy-alias: listEmbeddedOrganizationsByUser x-speakeasy-group: EmbeddedWidget responses: '200': description: Successfully retrieved organizations content: application/json: schema: $ref: '#/components/schemas/EmbeddedOrganizationsList' examples: listEmbeddedOrganizationsByUser200Example: summary: Default listEmbeddedOrganizationsByUser 200 response x-microcks-default: true value: organizations: example '403': $ref: '#/components/responses/ForbiddenResponse' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: responses: InitiateOauthResponse: content: application/json: {} description: Response from the initiate OAuth call should be an object with a single property which will be the `redirect_url`. If a user is redirected to this URL, they'll be prompted by the identity provider to authenticate. x-speakeasy-component: true schemas: WorkspaceId: type: string format: uuid x-speakeasy-component: true DeclarativeManifest: x-speakeasy-component: true x-speakeasy-type-override: any x-speakeasy-terraform-custom-type: imports: - github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes schemaType: jsontypes.NormalizedType{} valueType: jsontypes.Normalized description: Low code CDK manifest JSON object type: object ManifestVersion: x-speakeasy-component: true type: integer format: int64 SourceDefinitionSpecification: description: The specification for what values are required to configure the sourceDefinition. type: object example: user: type: string x-speakeasy-component: true SourceConfiguration: type: object description: The values required to configure the source. The schema for this must match the schema return by source_definition_specifications/get for the source. example: user: charles x-speakeasy-component: true DestinationConfiguration: type: object description: The values required to configure the destination. The schema for this must match the schema return by destination_definition_specifications/get for the destinationDefinition. example: user: charles x-speakeasy-component: true NamespaceDefinitionType: type: string description: Method used for computing final namespace in destination enum: - source - destination - customformat x-speakeasy-component: true TagId: type: string format: uuid x-speakeasy-component: true Tag: description: A tag that can be associated with a connection. Useful for grouping and organizing connections in a workspace. type: object x-speakeasy-component: true required: - tagId - workspaceId - name - color properties: tagId: $ref: '#/components/schemas/TagId' workspaceId: $ref: '#/components/schemas/WorkspaceId' name: type: string color: type: string OrganizationId: type: string format: uuid x-speakeasy-component: true PermissionType: type: string description: Describes what actions/endpoints the permission entitles to enum: - instance_admin - organization_admin - organization_editor - organization_runner - organization_reader - organization_member - workspace_owner - workspace_admin - workspace_runner - workspace_editor - workspace_reader x-speakeasy-component: true PublicPermissionType: type: string description: Subset of `PermissionType` (removing `instance_admin`), could be used in public-api. enum: - organization_admin - organization_editor - organization_runner - organization_reader - organization_member - workspace_admin - workspace_editor - workspace_runner - workspace_reader x-speakeasy-component: true UserId: type: string description: Internal Airbyte user ID format: uuid x-speakeasy-component: true AuthProvider: type: string description: Auth Provider default: airbyte enum: - airbyte - google_identity_platform - keycloak x-speakeasy-component: true UserStatus: type: string description: user status enum: - invited - registered - disabled x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true SelectedFieldInfo: type: object description: Path to a field/column/property in a stream to be selected. For example, if the field to be selected is a database column called "foo", this will be ["foo"]. Use multiple path elements for nested schemas. properties: fieldPath: type: array items: type: string x-speakeasy-component: true StreamMapperType: type: string enum: - hashing - field-renaming - row-filtering - encryption - field-filtering x-speakeasy-component: true ConfiguredStreamMapper: type: object required: - type - mapperConfiguration properties: id: type: string format: uuid type: $ref: '#/components/schemas/StreamMapperType' mapperConfiguration: $ref: '#/components/schemas/MapperConfiguration' x-speakeasy-component: true MapperConfiguration: type: object description: The values required to configure the mapper. oneOf: - $ref: '#/components/schemas/HashingMapperConfiguration' - $ref: '#/components/schemas/FieldFilteringMapperConfiguration' - $ref: '#/components/schemas/FieldRenamingMapperConfiguration' - $ref: '#/components/schemas/RowFilteringMapperConfiguration' - $ref: '#/components/schemas/EncryptionMapperConfiguration' x-speakeasy-component: true HashingMapperConfiguration: title: Hashing type: object properties: fieldNameSuffix: type: string title: Field name suffix description: The suffix to append to the field name after hashing. method: type: string enum: - MD2 - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 title: Hashing method description: The hashing algorithm to use. targetField: type: string title: Original Field Name description: The name of the field to be hashed. required: - fieldNameSuffix - method - targetField x-speakeasy-component: true FieldFilteringMapperConfiguration: title: Field Filtering type: object properties: targetField: type: string title: The Field to Filter description: The name of the field to filter. required: - targetField x-speakeasy-component: true FieldRenamingMapperConfiguration: title: Field Renaming type: object properties: newFieldName: type: string title: New Field Name description: The new name for the field after renaming. originalFieldName: type: string title: Original Field Name description: The current name of the field to rename. required: - newFieldName - originalFieldName x-speakeasy-component: true RowFilteringOperationType: type: string enum: - EQUAL - NOT x-speakeasy-component: true RowFilteringOperationEqual: type: object title: EQUAL required: - comparisonValue - fieldName - type properties: comparisonValue: type: string title: Comparison Value description: The value to compare the field against. fieldName: type: string title: Field Name description: The name of the field to apply the operation on. type: $ref: '#/components/schemas/RowFilteringOperationType' x-speakeasy-component: true RowFilteringOperationNot: type: object title: NOT required: - conditions - type properties: conditions: title: Sub-Conditions (NOT) description: Conditions to evaluate with the NOT operator. minItems: 1 type: array items: $ref: '#/components/schemas/RowFilteringOperation' type: $ref: '#/components/schemas/RowFilteringOperationType' x-speakeasy-component: true RowFilteringOperation: type: object oneOf: - $ref: '#/components/schemas/RowFilteringOperationEqual' - $ref: '#/components/schemas/RowFilteringOperationNot' discriminator: propertyName: type mapping: EQUAL: '#/components/schemas/RowFilteringOperationEqual' NOT: '#/components/schemas/RowFilteringOperationNot' x-speakeasy-component: true x-airbyte-circular-ref: true RowFilteringMapperConfiguration: title: Row Filtering type: object properties: conditions: $ref: '#/components/schemas/RowFilteringOperation' required: - conditions x-speakeasy-component: true EncryptionMapperAlgorithm: type: string enum: - RSA - AES x-speakeasy-component: true EncryptionMapperConfiguration: title: Encryption type: object oneOf: - $ref: '#/components/schemas/EncryptionMapperRSAConfiguration' - $ref: '#/components/schemas/EncryptionMapperAESConfiguration' discriminator: propertyName: algorithm mapping: RSA: '#/components/schemas/EncryptionMapperRSAConfiguration' AES: '#/components/schemas/EncryptionMapperAESConfiguration' x-speakeasy-component: true EncryptionMapperRSAConfiguration: title: Encryption - RSA type: object properties: algorithm: $ref: '#/components/schemas/EncryptionMapperAlgorithm' fieldNameSuffix: type: string publicKey: type: string targetField: type: string required: - algorithm - publicKey - targetField - fieldNameSuffix x-speakeasy-component: true EncryptionMapperAESConfiguration: title: Encryption - AES type: object properties: algorithm: $ref: '#/components/schemas/EncryptionMapperAlgorithm' fieldNameSuffix: type: string key: type: string x-speakeasy-param-sensitive: true mode: type: string enum: - CBC - CFB - OFB - CTR - GCM - ECB padding: type: string enum: - NoPadding - PKCS5Padding targetField: type: string required: - algorithm - key - mode - padding - targetField - fieldNameSuffix x-speakeasy-component: true SelectedFields: description: Paths to the fields that will be included in the configured catalog. type: array format: set items: $ref: '#/components/schemas/SelectedFieldInfo' x-speakeasy-component: true ScopedResourceRequirements: x-speakeasy-component: true description: actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level. type: object additionalProperties: false properties: default: $ref: '#/components/schemas/ResourceRequirements' jobSpecific: type: array items: $ref: '#/components/schemas/JobTypeResourceLimit' ActorDefinitionId: description: A unique identifier for an actor definition. type: string format: uuid x-speakeasy-component: true JobTypeResourceLimit: x-speakeasy-component: true description: sets resource requirements for a specific job type for an actor or actor definition. these values override the default, if both are set. type: object additionalProperties: false required: - jobType - resourceRequirements properties: jobType: $ref: '#/components/schemas/JobType' resourceRequirements: $ref: '#/components/schemas/ResourceRequirements' JobType: x-speakeasy-component: true description: enum that describes the different types of jobs that the platform runs. type: string enum: - get_spec - check_connection - discover_schema - sync - reset_connection - connection_updater - replicate ResourceRequirements: x-speakeasy-component: true description: optional resource requirements to run workers (blank for unbounded allocations) type: object properties: cpu_request: type: string cpu_limit: type: string memory_request: type: string memory_limit: type: string ephemeral_storage_request: type: string ephemeral_storage_limit: type: string OAuthConfiguration: description: The values required to configure OAuth flows. The schema for this must match the `OAuthConfigSpecification.oauthUserInputFromConnectorConfigSpecification` schema. x-speakeasy-component: true OAuthInputConfiguration: $ref: '#/components/schemas/OAuthConfiguration' x-speakeasy-component: true NonBreakingChangesPreference: enum: - ignore - disable - propagate_columns - propagate_fully type: string x-speakeasy-component: true ApplicationCreate: required: - name type: object properties: name: type: string x-speakeasy-component: true ApplicationReadList: required: - applications type: object properties: applications: type: array items: $ref: '#/components/schemas/ApplicationRead' x-speakeasy-component: true ApplicationRead: required: - id - name - clientId - clientSecret - createdAt type: object properties: id: type: string name: type: string clientId: type: string clientSecret: type: string createdAt: type: integer format: int64 x-speakeasy-component: true ApplicationTokenRequestWithGrant: required: - client_id - client_secret - grant_type type: object properties: client_id: type: string client_secret: type: string grant-type: enum: - client_credentials x-speakeasy-component: true PublicAccessTokenResponse: required: - access_token - token_type - expires_in type: object properties: access_token: type: string token_type: enum: - Bearer expires_in: type: integer format: int64 x-speakeasy-component: true RedirectUrlResponse: title: Root Type for RedirectUrlResponse description: '' type: object properties: redirectUrl: format: url type: string example: redirectUrl: https://example.com x-speakeasy-component: true JobResponse: title: Root Type for JobResponse description: Provides details of a single job. required: - jobId - status - jobType - startTime - connectionId type: object properties: jobId: format: int64 type: integer status: $ref: '#/components/schemas/JobStatusEnum' jobType: $ref: '#/components/schemas/JobTypeEnum' startTime: type: string connectionId: format: UUID type: string lastUpdatedAt: type: string duration: description: Duration of a sync in ISO_8601 format type: string bytesSynced: format: int64 type: integer rowsSynced: format: int64 type: integer example: id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 status: running jobType: sync startTime: 2023-03-25T01:30:50Z duration: PT8H6M12S x-speakeasy-component: true JobsResponse: title: Root Type for JobsResponse description: '' required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/JobResponse' example: next: https://api.airbyte.com/v1/jobs?limit=5&offset=10 previous: https://api.airbyte.com/v1/jobs?limit=5&offset=0 data: - id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 status: running jobType: sync startTime: 2023-03-25T01:30:50Z x-speakeasy-component: true ConnectionCreateRequest: required: - sourceId - destinationId type: object properties: name: description: Optional name of the connection type: string sourceId: format: uuid type: string destinationId: format: uuid type: string configurations: $ref: '#/components/schemas/StreamConfigurations' schedule: $ref: '#/components/schemas/AirbyteApiConnectionSchedule' dataResidency: deprecated: true x-speakeasy-deprecation-message: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace. type: string namespaceDefinition: $ref: '#/components/schemas/NamespaceDefinitionEnum' namespaceFormat: type: string description: Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. default: example: ${SOURCE_NAMESPACE} prefix: type: string description: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). default: '' nonBreakingSchemaUpdatesBehavior: $ref: '#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum' status: $ref: '#/components/schemas/ConnectionStatusEnum' tags: type: array items: $ref: '#/components/schemas/Tag' x-speakeasy-entity: Connection x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true ConnectionPatchRequest: type: object properties: name: description: Optional name of the connection type: string configurations: $ref: '#/components/schemas/StreamConfigurations' schedule: $ref: '#/components/schemas/AirbyteApiConnectionSchedule' dataResidency: deprecated: true x-speakeasy-deprecation-message: We no longer support modifying dataResidency on Community and Enterprise connections. All connections will use the dataResidency of their associated workspace. type: string namespaceDefinition: $ref: '#/components/schemas/NamespaceDefinitionEnumNoDefault' namespaceFormat: type: string description: Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. default: example: ${SOURCE_NAMESPACE} prefix: type: string description: Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). nonBreakingSchemaUpdatesBehavior: $ref: '#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnumNoDefault' status: $ref: '#/components/schemas/ConnectionStatusEnum' tags: type: array items: $ref: '#/components/schemas/Tag' x-speakeasy-entity: Connection x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true JobCreateRequest: title: Root Type for JobCreate description: Creates a new Job from the configuration provided in the request body. required: - jobType - connectionId type: object properties: connectionId: format: UUID type: string jobType: $ref: '#/components/schemas/JobTypeEnum' example: connectionId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 jobType: sync x-speakeasy-component: true JobStatusEnum: enum: - pending - running - incomplete - failed - succeeded - cancelled type: string x-speakeasy-component: true JobTypeEnum: description: Enum that describes the different types of jobs that the platform runs. enum: - sync - reset - refresh - clear type: string x-speakeasy-component: true SourceCreateRequest: required: - name - workspaceId - configuration type: object properties: name: description: Name of the source e.g. dev-mysql-instance. type: string definitionId: description: The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. format: uuid type: string workspaceId: format: uuid type: string configuration: $ref: '#/components/schemas/SourceConfiguration' secretId: description: Optional secretID obtained through the OAuth redirect flow. type: string resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Source x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true SourcePutRequest: required: - name - configuration type: object properties: name: type: string configuration: $ref: '#/components/schemas/SourceConfiguration' resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Source x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true SourcePatchRequest: type: object properties: name: type: string example: My source workspaceId: format: uuid type: string configuration: $ref: '#/components/schemas/SourceConfiguration' secretId: description: Optional secretID obtained through the OAuth redirect flow. type: string resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Source x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true TagCreateRequest: required: - name - color - workspaceId type: object properties: name: type: string color: type: string workspaceId: $ref: '#/components/schemas/WorkspaceId' x-speakeasy-entity: Tag x-speakeasy-component: true TagPatchRequest: required: - name - color type: object properties: name: type: string color: type: string x-speakeasy-entity: Tag x-speakeasy-component: true InitiateOauthRequest: title: Root Type for initiate-oauth-post-body required: - redirectUrl - workspaceId type: object properties: name: description: The name of the source to authenticate to. Deprecated - use sourceType instead. type: string sourceType: description: The name of the source to authenticate to type: string redirectUrl: description: The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete. type: string workspaceId: format: uuid description: The workspace to create the secret and eventually the full source. type: string oAuthInputConfiguration: $ref: '#/components/schemas/OAuthInputConfiguration' description: Input configuration for OAuth required by some sources. requestedScopes: type: array description: >- Optional OAuth scopes to request, overriding the connector's default scopes. Only supported for connectors that define scopes as an array. items: type: string requestedOptionalScopes: type: array description: >- Optional OAuth optional_scopes to request, overriding the connector's default optional_scopes. Only applied when requestedScopes is also provided. items: type: string example: redirectUrl: https://cloud.airbyte.io/v1/api/oauth/callback workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e destinationId: 3d93b16c-ff5f-421c-8908-5a3c82088f14 x-speakeasy-component: true WorkspaceOAuthCredentialsRequest: title: Root Type for WorkspaceOAuthCredentials description: POST body for creating/updating workspace level OAuth credentials required: - actorType - name - configuration type: object properties: actorType: $ref: '#/components/schemas/ActorTypeEnum' name: type: string description: The name of the source i.e. google-ads configuration: $ref: '#/components/schemas/OAuthCredentialsConfiguration' x-speakeasy-component: true OrganizationOAuthCredentialsRequest: title: Root Type for OrganizationOAuthCredentials description: POST body for creating/updating organization level OAuth credentials required: - actorType - name - configuration type: object properties: actorType: $ref: '#/components/schemas/ActorTypeEnum' name: type: string description: The name of the source i.e. google-ads configuration: $ref: '#/components/schemas/OAuthCredentialsConfiguration' x-speakeasy-component: true OAuthCredentialsConfiguration: description: The configuration for this source/destination based on the OAuth section of the relevant specification. type: object example: credentials: client_id: 871d9b60-11d1-44cb-8c92-c246d53bf87e client_secret: shhhhhh x-speakeasy-component: true ConnectionResponse: title: Root Type for ConnectionResponse description: Provides details of a single connection. type: object required: - connectionId - name - sourceId - destinationId - workspaceId - status - schedule - configurations - createdAt - tags properties: connectionId: format: UUID type: string name: type: string sourceId: format: UUID type: string destinationId: format: UUID type: string workspaceId: format: UUID type: string status: $ref: '#/components/schemas/ConnectionStatusEnum' schedule: $ref: '#/components/schemas/ConnectionScheduleResponse' nonBreakingSchemaUpdatesBehavior: $ref: '#/components/schemas/NonBreakingSchemaUpdatesBehaviorEnum' namespaceDefinition: $ref: '#/components/schemas/NamespaceDefinitionEnum' namespaceFormat: type: string prefix: type: string configurations: $ref: '#/components/schemas/StreamConfigurations' createdAt: format: int64 type: integer tags: type: array items: $ref: '#/components/schemas/Tag' statusReason: type: string x-speakeasy-entity: Connection x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true AirbyteApiConnectionSchedule: description: schedule for when the the connection should run, per the schedule type type: object required: - scheduleType properties: scheduleType: $ref: '#/components/schemas/ScheduleTypeEnum' cronExpression: type: string x-speakeasy-component: true ScheduleTypeEnum: type: string enum: - manual - cron x-speakeasy-component: true ConnectionScheduleResponse: description: schedule for when the the connection should run, per the schedule type type: object required: - scheduleType properties: scheduleType: $ref: '#/components/schemas/ScheduleTypeWithBasicEnum' cronExpression: type: string basicTiming: type: string x-speakeasy-component: true ScheduleTypeWithBasicEnum: type: string enum: - manual - cron - basic x-speakeasy-component: true ConnectionStatusEnum: type: string enum: - active - inactive - deprecated - locked x-speakeasy-component: true NamespaceDefinitionEnum: type: string description: Define the location where the data will be stored in the destination enum: - source - destination - custom_format default: destination x-speakeasy-component: true NonBreakingSchemaUpdatesBehaviorEnum: type: string description: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source enum: - ignore - disable_connection - propagate_columns - propagate_fully default: ignore x-speakeasy-component: true NamespaceDefinitionEnumNoDefault: type: string description: Define the location where the data will be stored in the destination enum: - source - destination - custom_format x-speakeasy-component: true NonBreakingSchemaUpdatesBehaviorEnumNoDefault: type: string description: Set how Airbyte handles syncs when it detects a non-breaking schema change in the source enum: - ignore - disable_connection - propagate_columns - propagate_fully x-speakeasy-component: true DestinationResponse: title: Root Type for DestinationResponse description: Provides details of a single destination. type: object required: - destinationId - name - destinationType - definitionId - workspaceId - configuration - createdAt properties: destinationId: format: UUID type: string name: type: string destinationType: type: string definitionId: format: UUID type: string workspaceId: format: UUID type: string configuration: $ref: '#/components/schemas/DestinationConfiguration' createdAt: format: int64 type: integer resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' example: destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Analytics Team Postgres destinationType: postgres workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e definitionId: 321d9b60-11d1-44cb-8c92-c246d53bf98e x-speakeasy-component: true SourceResponse: title: Root Type for SourceResponse description: Provides details of a single source. type: object required: - sourceId - name - sourceType - workspaceId - configuration - definitionId - createdAt properties: sourceId: format: UUID type: string name: type: string sourceType: type: string definitionId: format: UUID type: string workspaceId: format: UUID type: string configuration: $ref: '#/components/schemas/SourceConfiguration' createdAt: format: int64 type: integer resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' example: sourceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Analytics Team Postgres sourceType: postgres workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e definitionId: 321d9b60-11d1-44cb-8c92-c246d53bf98e x-speakeasy-component: true ConnectorDefinitionResponse: title: Root Type for ConnectorDefinitionResponse description: Provides details of a single connector definition. type: object required: - id - connectorDefinitionType - name - version properties: id: format: UUID type: string name: type: string connectorDefinitionType: $ref: '#/components/schemas/ConnectorType' version: type: string example: id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Postgres connectorDefinnitionType: source version: 0.2.0 x-speakeasy-component: true ConnectorType: type: string enum: - source - destination x-speakeasy-component: true TagResponse: title: Root Type for TagResponse description: Provides details of a single tag. type: object required: - tagId - name - color - workspaceId properties: tagId: $ref: '#/components/schemas/TagId' name: type: string color: description: A hexadecimal color value type: string workspaceId: $ref: '#/components/schemas/WorkspaceId' example: tagId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Analytics Team color: FF5733 workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e x-speakeasy-component: true DestinationCreateRequest: required: - name - workspaceId - configuration type: object properties: name: description: Name of the destination e.g. dev-mysql-instance. type: string definitionId: description: The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. format: uuid type: string workspaceId: format: uuid type: string configuration: $ref: '#/components/schemas/DestinationConfiguration' resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Destination x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true DestinationPatchRequest: type: object properties: name: type: string configuration: $ref: '#/components/schemas/DestinationConfiguration' resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Destination x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true DestinationPutRequest: required: - name - configuration type: object properties: name: type: string configuration: $ref: '#/components/schemas/DestinationConfiguration' resourceAllocation: $ref: '#/components/schemas/ScopedResourceRequirements' x-implements: io.airbyte.api.common.ConfigurableActor x-speakeasy-entity: Destination x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true WorkspaceCreateRequest: required: - name type: object properties: name: description: Name of the workspace type: string organizationId: description: ID of organization to add workspace to. format: uuid type: string notifications: $ref: '#/components/schemas/NotificationsConfig' regionId: type: string format: uuid x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true WorkspaceUpdateRequest: type: object properties: name: description: Name of the workspace type: string notifications: $ref: '#/components/schemas/NotificationsConfig' regionId: type: string format: uuid x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true WorkspaceResponse: title: Root Type for WorkspaceResponse description: Provides details of a single workspace. type: object required: - workspaceId - name - dataResidency - notifications properties: workspaceId: format: UUID type: string name: type: string dataResidency: type: string notifications: $ref: '#/components/schemas/NotificationsConfig' x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true NotificationsConfig: description: Configures workspace notifications. type: object properties: failure: $ref: '#/components/schemas/NotificationConfig' success: $ref: '#/components/schemas/NotificationConfig' connectionUpdate: $ref: '#/components/schemas/NotificationConfig' connectionUpdateActionRequired: $ref: '#/components/schemas/NotificationConfig' syncDisabled: $ref: '#/components/schemas/NotificationConfig' syncDisabledWarning: $ref: '#/components/schemas/NotificationConfig' x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true NotificationConfig: description: Configures a notification. type: object properties: email: $ref: '#/components/schemas/EmailNotificationConfig' webhook: $ref: '#/components/schemas/WebhookNotificationConfig' x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true WebhookNotificationConfig: description: Configures a webhook notification. type: object properties: enabled: type: boolean url: type: string x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true EmailNotificationConfig: description: Configures an email notification. type: object properties: enabled: type: boolean x-speakeasy-entity: Workspace x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true UserResponse: title: Root Type for UserResponse description: Provides details of a single user in an organization. type: object required: - id - name - email properties: name: description: Name of the user type: string id: $ref: '#/components/schemas/UserId' email: type: string format: email x-speakeasy-entity: User x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true UsersResponse: title: Root Type for UsersResponse description: List/Array of multiple users in an organization required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/UserResponse' x-speakeasy-component: true x-speakeasy-entity: User x-speakeasy-param-suppress-computed-diff: true GroupResponse: title: Root Type for GroupResponse description: Provides details of a single group type: object required: - groupId - name - organizationId - memberCount properties: groupId: type: string format: uuid description: The ID of the group name: type: string description: The name of the group description: type: string nullable: true description: Optional description of the group organizationId: type: string format: uuid description: The ID of the organization the group belongs to memberCount: type: integer format: int64 description: The number of members in the group x-speakeasy-component: true x-speakeasy-entity: Group x-speakeasy-param-suppress-computed-diff: true GroupsResponse: title: Root Type for GroupsResponse description: List/Array of multiple groups required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/GroupResponse' next: type: string description: Link to the next page of results nullable: true previous: type: string description: Link to the previous page of results nullable: true x-speakeasy-component: true x-speakeasy-entity: Group x-speakeasy-param-suppress-computed-diff: true GroupCreateRequest: title: Root Type for GroupCreateRequest description: Request body for creating a group required: - name - organizationId type: object properties: name: type: string description: The name of the group description: type: string nullable: true description: Optional description of the group organizationId: type: string format: uuid description: The ID of the organization the group belongs to x-speakeasy-component: true x-speakeasy-entity: Group x-speakeasy-param-suppress-computed-diff: true GroupUpdateRequest: title: Root Type for GroupUpdateRequest description: Request body for updating a group type: object properties: name: type: string description: The updated name of the group description: type: string nullable: true description: The updated description of the group x-speakeasy-component: true x-speakeasy-entity: Group x-speakeasy-param-suppress-computed-diff: true GroupMemberResponse: title: Root Type for GroupMemberResponse description: Provides details of a single group member type: object required: - memberId - groupId - userId - userEmail - userName properties: memberId: type: string format: uuid description: The ID of the group membership groupId: type: string format: uuid description: The ID of the group userId: type: string format: uuid description: The ID of the user userEmail: type: string format: email description: The email of the user userName: type: string description: The name of the user x-speakeasy-component: true x-speakeasy-entity: GroupMember x-speakeasy-param-suppress-computed-diff: true GroupMembersResponse: title: Root Type for GroupMembersResponse description: List/Array of group members required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/GroupMemberResponse' next: type: string description: Link to the next page of results nullable: true previous: type: string description: Link to the previous page of results nullable: true x-speakeasy-component: true x-speakeasy-entity: GroupMember x-speakeasy-param-suppress-computed-diff: true GroupMemberAddRequest: title: Root Type for GroupMemberAddRequest description: Request body for adding a member to a group required: - userId type: object properties: userId: type: string format: uuid description: The ID of the user to add to the group x-speakeasy-component: true x-speakeasy-entity: GroupMember x-speakeasy-param-suppress-computed-diff: true GroupPermissionResponse: title: Root Type for GroupPermissionResponse description: Provides details of a single group permission type: object required: - permissionId - groupId - permissionType properties: permissionId: type: string format: uuid description: The ID of the permission groupId: type: string format: uuid description: The ID of the group permissionType: $ref: '#/components/schemas/PermissionType' workspaceId: type: string format: uuid nullable: true description: The workspace ID for workspace-scoped permissions organizationId: type: string format: uuid nullable: true description: The organization ID for organization-scoped permissions x-speakeasy-component: true x-speakeasy-entity: GroupPermission x-speakeasy-param-suppress-computed-diff: true GroupPermissionsResponse: title: Root Type for GroupPermissionsResponse description: List/Array of group permissions required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/GroupPermissionResponse' x-speakeasy-component: true x-speakeasy-entity: GroupPermission x-speakeasy-param-suppress-computed-diff: true GroupPermissionCreateRequest: title: Root Type for GroupPermissionCreateRequest description: Request body for creating a group permission required: - permissionType type: object properties: permissionType: $ref: '#/components/schemas/PermissionType' workspaceId: type: string format: uuid nullable: true description: Required for workspace-scoped permissions organizationId: type: string format: uuid nullable: true description: Required for organization-scoped permissions oneOf: - required: - workspaceId - required: - organizationId x-speakeasy-component: true x-speakeasy-entity: GroupPermission x-speakeasy-param-suppress-computed-diff: true PermissionCreateRequest: required: - permissionType - userId type: object properties: permissionType: $ref: '#/components/schemas/PublicPermissionType' userId: $ref: '#/components/schemas/UserId' workspaceId: $ref: '#/components/schemas/WorkspaceId' organizationId: $ref: '#/components/schemas/OrganizationId' x-speakeasy-entity: Permission x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true PermissionUpdateRequest: required: - permissionType type: object properties: permissionType: $ref: '#/components/schemas/PermissionType' x-speakeasy-entity: Permission x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true PermissionResponse: title: Root Type for PermissionResponse description: Provides details of a single permission. type: object required: - permissionId - permissionType - userId properties: permissionId: type: string format: uuid permissionType: $ref: '#/components/schemas/PermissionType' userId: $ref: '#/components/schemas/UserId' workspaceId: $ref: '#/components/schemas/WorkspaceId' organizationId: $ref: '#/components/schemas/OrganizationId' x-speakeasy-entity: Permission x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true PermissionScope: description: Scope of a single permission, e.g. workspace, organization type: string enum: - workspace - organization - none x-speakeasy-component: true PermissionResponseRead: title: Root type for PermissionResponseRead description: Reformat PermissionResponse with permission scope type: object required: - permissionId - permissionType - userId - scope - scopeId properties: permissionId: type: string format: uuid permissionType: $ref: '#/components/schemas/PermissionType' userId: $ref: '#/components/schemas/UserId' scopeId: type: string format: uuid scope: $ref: '#/components/schemas/PermissionScope' x-speakeasy-entity: Permission x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true PermissionsResponse: title: Root Type for PermissionsResponse description: List/Array of multiple permissions required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/PermissionResponseRead' x-speakeasy-component: true OrganizationResponse: title: Root Type for OrganizationResponse description: Provides details of a single organization for a user. type: object required: - organizationId - organizationName - email properties: organizationId: $ref: '#/components/schemas/OrganizationId' organizationName: type: string email: type: string format: email x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true OrganizationsResponse: title: Root Type for OrganizationsResponse description: List/Array of multiple organizations. required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationResponse' x-speakeasy-component: true ConnectionsResponse: title: Root Type for ConnectionsResponse description: '' required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/ConnectionResponse' default: [] example: next: https://api.airbyte.com/v1/connections?limit=5&offset=10 previous: https://api.airbyte.com/v1/connections?limit=5&offset=0 data: - name: test-connection - connection_id: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 - sourceId: 49237019-645d-47d4-b45b-5eddf97775ce - destinationId: al312fs-0ab1-4f72-9ed7-0b8fc27c5826 - schedule: scheduleType: manual - status: active x-speakeasy-component: true SourcesResponse: title: Root Type for SourcesResponse description: '' required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/SourceResponse' example: next: https://api.airbyte.com/v1/sources?limit=5&offset=10 previous: https://api.airbyte.com/v1/sources?limit=5&offset=0 data: sourceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Analytics Team Postgres sourceType: postgres workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e x-speakeasy-component: true DestinationsResponse: title: Root Type for DestinationsResponse description: '' required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/DestinationResponse' example: next: https://api.airbyte.com/v1/destinations?limit=5&offset=10 previous: https://api.airbyte.com/v1/destinations?limit=5&offset=0 data: destinationId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Analytics Team Postgres destinationType: postgres workspaceId: 871d9b60-11d1-44cb-8c92-c246d53bf87e x-speakeasy-component: true ConnectorDefinitionsResponse: title: Root Type for DefinitionsResponse description: '' required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/ConnectorDefinitionResponse' x-speakeasy-component: true CreateDeclarativeSourceDefinitionRequest: type: object x-speakeasy-component: true required: - workspaceId - name - manifest properties: name: type: string manifest: $ref: '#/components/schemas/DeclarativeManifest' UpdateDeclarativeSourceDefinitionRequest: type: object x-speakeasy-component: true required: - manifest properties: manifest: $ref: '#/components/schemas/DeclarativeManifest' DeclarativeSourceDefinitionsResponse: title: Root Type for DeclarativeSourceDefinitionsResponse description: '' x-speakeasy-component: true required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/DeclarativeSourceDefinitionResponse' DeclarativeSourceDefinitionResponse: type: object x-speakeasy-component: true required: - id - name - manifest - version properties: id: format: UUID type: string name: type: string manifest: $ref: '#/components/schemas/DeclarativeManifest' version: x-speakeasy-terraform-ignore: true $ref: '#/components/schemas/ManifestVersion' CreateDefinitionRequest: type: object x-speakeasy-component: true required: - name - dockerRepository - dockerImageTag properties: name: type: string dockerRepository: type: string dockerImageTag: type: string documentationUrl: type: string format: uri UpdateDefinitionRequest: type: object x-speakeasy-component: true required: - name - dockerImageTag properties: name: type: string dockerImageTag: type: string DefinitionsResponse: title: Root Type for DefinitionsResponse description: '' x-speakeasy-component: true required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/DefinitionResponse' DefinitionResponse: title: Root Type for DefinitionResponse description: Provides details of a single connector definition. type: object x-speakeasy-component: true required: - id - name - dockerRepository - dockerImageTag properties: id: format: UUID type: string name: type: string dockerRepository: type: string dockerImageTag: type: string documentationUrl: type: string WorkspacesResponse: title: Root Type for WorkspacesResponse description: '' required: - data type: object properties: previous: type: string next: type: string data: type: array items: $ref: '#/components/schemas/WorkspaceResponse' example: next: https://api.airbyte.com/v1/workspaces?limit=5&offset=10 previous: https://api.airbyte.com/v1/workspaces?limit=5&offset=0 data: workspaceId: 18dccc91-0ab1-4f72-9ed7-0b8fc27c5826 name: Acme Company dataResidency: auto x-speakeasy-component: true TagsResponse: title: Root Type for TagsResponse description: '' required: - data type: object properties: data: type: array items: $ref: '#/components/schemas/TagResponse' x-speakeasy-component: true StreamConfiguration: description: Configurations for a single stream. type: object required: - name properties: name: type: string namespace: type: string description: Namespace of the stream. syncMode: $ref: '#/components/schemas/ConnectionSyncModeEnum' cursorField: description: Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental` unless there is a default. type: array items: type: string primaryKey: description: Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup` unless it is already supplied by the source schema. type: array items: type: array items: type: string includeFiles: description: Whether to move raw files from the source to the destination during the sync. type: boolean destinationObjectName: description: The name of the destination object that this stream will be written to, used for data activation destinations. type: string selectedFields: description: By default (if not provided in the request) all fields will be synced. Otherwise, only the fields in this list will be synced. $ref: '#/components/schemas/SelectedFields' mappers: description: Mappers that should be applied to the stream before writing to the destination. type: array items: $ref: '#/components/schemas/ConfiguredStreamMapper' x-speakeasy-component: true StreamConfigurations: description: A list of configured stream options for a connection. type: object properties: streams: type: array format: set items: $ref: '#/components/schemas/StreamConfiguration' x-speakeasy-component: true StreamPropertiesResponse: description: A list of stream properties. type: array items: $ref: '#/components/schemas/StreamProperties' x-speakeasy-component: true StreamProperties: description: The stream properties associated with a connection. type: object properties: streamName: type: string syncModes: type: array items: $ref: '#/components/schemas/ConnectionSyncModeEnum' streamnamespace: type: string defaultCursorField: type: array items: type: string sourceDefinedCursorField: type: boolean sourceDefinedPrimaryKey: type: array items: type: array items: type: string propertyFields: type: array items: type: array items: type: string x-speakeasy-component: true ConnectionSyncModeEnum: enum: - full_refresh_overwrite - full_refresh_overwrite_deduped - full_refresh_append - full_refresh_update - full_refresh_soft_delete - incremental_append - incremental_deduped_history - incremental_update - incremental_soft_delete x-speakeasy-component: true ActorTypeEnum: description: Whether you're setting this override for a source or destination enum: - source - destination x-speakeasy-component: true RegionCreateRequest: type: object required: - name - organizationId properties: name: type: string organizationId: type: string format: uuid enabled: type: boolean x-speakeasy-entity: Region x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true RegionPatchRequest: type: object properties: name: type: string enabled: type: boolean x-speakeasy-entity: Region x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true RegionResponse: type: object required: - regionId - name - organizationId - enabled - createdAt - updatedAt properties: regionId: type: string format: uuid name: type: string organizationId: type: string format: uuid enabled: type: boolean createdAt: type: string updatedAt: type: string x-speakeasy-entity: Region x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true RegionsResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/RegionResponse' x-speakeasy-component: true DataplaneCreateRequest: type: object required: - regionId - name properties: regionId: type: string format: uuid name: type: string enabled: type: boolean x-speakeasy-entity: Dataplane x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true DataplanePatchRequest: type: object properties: name: type: string enabled: type: boolean x-speakeasy-entity: Dataplane x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true DataplaneResponse: type: object required: - dataplaneId - name - regionId - enabled - createdAt - updatedAt properties: dataplaneId: type: string format: uuid name: type: string regionId: type: string format: uuid enabled: type: boolean createdAt: type: string updatedAt: type: string x-speakeasy-entity: Dataplane x-speakeasy-param-suppress-computed-diff: true x-speakeasy-component: true DataplanesResponse: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/DataplaneResponse' x-speakeasy-component: true EmbeddedWidgetRequest: type: object required: - allowedOrigin - externalUserId - organizationId properties: allowedOrigin: type: string externalUserId: type: string organizationId: type: string format: uuid x-speakeasy-component: true EmbeddedWidgetResponse: type: object required: - token properties: token: type: string x-speakeasy-component: true EmbeddedScopedTokenRequest: type: object required: - workspaceId properties: workspaceId: type: string format: uuid x-speakeasy-component: true EmbeddedScopedTokenResponse: type: object required: - token properties: token: type: string x-speakeasy-component: true EmbeddedOrganizationsList: required: - organizations properties: organizations: type: array items: $ref: '#/components/schemas/EmbeddedOrganizationListItem' x-speakeasy-component: true EmbeddedOrganizationListItem: type: object required: - organizationId - organizationName - permission properties: organizationId: type: string format: uuid organizationName: type: string permission: $ref: '#/components/schemas/PermissionType' x-speakeasy-component: true SSOConfigStatus: type: string enum: - draft - active x-speakeasy-component: true