REST API for Oracle Managed File Transfer

All REST Endpoints

Administration Service/MFT Application Metadata

Represents the MFT MDS metadata repository operations.

Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata
Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata

Administration Service/MFT Artifacts

Represents the MFT artifacts operations.

Create a MFT Artifact: Method: post

Path: /artifacts
DeleteArtifacts: Method: delete

Path: /artifacts
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
Method to update existing artifacts: Method: put

Path: /artifacts
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties

Administration Service/MFT Purge

Use the Purge APIs to purge old instance and payload data.

Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}

Event Service/Discover Sources

Discover available active MFT sources.

Get available active sources: Method: get

Path: /sources

Event Service/Invoke MFT Events

Trigger sources and get instance details of events.

Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances
Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Trigger a source: Method: post

Path: /events

MFT Catalog Service

Lists all the services available in MFT.

Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}
Get the list of available resources: Method: get

Path: /metadata-catalog

All Endpoints

Create a MFT Artifact: Method: post

Path: /artifacts
DeleteArtifacts: Method: delete

Path: /artifacts
Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
Get available active sources: Method: get

Path: /sources
Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}
Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Get the list of available resources: Method: get

Path: /metadata-catalog
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata
Method to update existing artifacts: Method: put

Path: /artifacts
Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}
Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Trigger a source: Method: post

Path: /events
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties

Administration Service/MFT Application Metadata

Represents the MFT MDS metadata repository operations.

Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata
Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}

Administration Service/MFT Artifacts

Represents the MFT artifacts operations.

DeleteArtifacts: Method: delete

Path: /artifacts
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
Create a MFT Artifact: Method: post

Path: /artifacts
Method to update existing artifacts: Method: put

Path: /artifacts
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}

Administration Service/MFT Purge

Use the Purge APIs to purge old instance and payload data.

Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}

Event Service/Discover Sources

Discover available active MFT sources.

Get available active sources: Method: get

Path: /sources

Event Service/Invoke MFT Events

Trigger sources and get instance details of events.

Trigger a source: Method: post

Path: /events
Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances

MFT Catalog Service

Lists all the services available in MFT.

Get the list of available resources: Method: get

Path: /metadata-catalog
Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}

All Endpoints

DeleteArtifacts: Method: delete

Path: /artifacts
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
Create a MFT Artifact: Method: post

Path: /artifacts
Method to update existing artifacts: Method: put

Path: /artifacts
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}
Trigger a source: Method: post

Path: /events
Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances
Get the list of available resources: Method: get

Path: /metadata-catalog
Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}
Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata
Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}
Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}
Get available active sources: Method: get

Path: /sources

Administration Service/MFT Application Metadata

Represents the MFT MDS metadata repository operations.

Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata

Administration Service/MFT Artifacts

Represents the MFT artifacts operations.

DeleteArtifacts: Method: delete

Path: /artifacts
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Create a MFT Artifact: Method: post

Path: /artifacts
Method to update existing artifacts: Method: put

Path: /artifacts
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties

Administration Service/MFT Purge

Use the Purge APIs to purge old instance and payload data.

Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}

Event Service/Discover Sources

Discover available active MFT sources.

Get available active sources: Method: get

Path: /sources

Event Service/Invoke MFT Events

Trigger sources and get instance details of events.

Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances
Trigger a source: Method: post

Path: /events

MFT Catalog Service

Lists all the services available in MFT.

Get the list of available resources: Method: get

Path: /metadata-catalog
Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}

All Endpoints

DeleteArtifacts: Method: delete

Path: /artifacts
Operation to delete specific artifact based on type and name: Method: delete

Path: /artifacts/{artifactType}/{artifactName}
Reset the entire MFT Metadata repository: Method: delete

Path: /mftapp/rest/v1/applicationMetadata
Export MFT artifacts in zip format and configPlan file in XML format: Method: get

Path: /artifacts
To check if artifact exists in MFT Repository: Method: get

Path: /artifacts/repository
Get the instances summary of an event: Method: get

Path: /events/{eventSessionId}
Get the details of the resultant instances of an event: Method: get

Path: /events/{eventSessionId}/instances
Get the list of available resources: Method: get

Path: /metadata-catalog
Get schema of the resource in string format: Method: get

Path: /metadata-catalog/{resource}
Get the download links for the MFT MDS archive and Config Plan files: Method: get

Path: /mftapp/rest/v1/applicationMetadata
Download the metadata file: Method: get

Path: /mftapp/rest/v1/applicationMetadata/{file}
Get available active sources: Method: get

Path: /sources
Create a MFT Artifact: Method: post

Path: /artifacts
Trigger a source: Method: post

Path: /events
Method to update existing artifacts: Method: put

Path: /artifacts
Updates the application properties on the server: Method: put

Path: /artifacts/appProperties
Updates the SFTP properties on the server: Method: put

Path: /artifacts/sftpProperties
Import the MFT metadata into the MFT MDS store: Method: put

Path: /mftapp/rest/v1/applicationMetadata
Modify Purge Schedule: Method: put

Path: /purges/schedules/{scheduleName}