Automation through REST API

This section outlines the REST API calls compatible with MetaDefender Managed File Transfer. Utilizing the Application's Interface, any third-party application can seamlessly interact and communicate with MetaDefender Managed File Transfer. This integration empowers the incorporation of MetaDefender Managed File Transfer into automated workflows.

Authentication

User-level authentication

Retrieve the authentication key by invoking the Request an API Key endpoint, bearing in mind that these keys have a finite lifespan and should be periodically refreshed to comply with the expiration policy. Additionally, their duration can be managed through session settings

API keys

Newly created API keys, restricted to administrator-level access, can be utilized for all API endpoints calls. Further details on API key generation can be found by referring to the provided link.

Authorization

Authorization through the Authorization header is mandatory for all API endpoints expect authentication endpoint. Users have the flexibility to opt for either user-level API key or employ an API key to bypass the authentication process for accessing the API endpoints.

Permissions

The API provides versatile access options, accommodating both user-level and admin-level (API key) permissions. This flexibility ensures secure interactions tailored to specific authorization requirements.

Response Codes (Status Codes)

The Metadefender Managed Transfer File API provides data in valid JSON format.

2xx status codes

All responses with 2xx status codes in the Metadefender Managed Transfer File API include a JSON body containing relevant keys and associated data.

{

    "message": null,

    "ui_message_key": null,

}

4xx status codes

Here are some of the commonly encountered 4xx class status codes when interacting with the MetaDefender Managed File Transfer API.

• 400 - Bad Request

  • When you encounter a 400 status code, it means there's an issue with the request you sent to the server. This could be due to missing parameters, incorrect data, or some other problem with the way you formed the request.

• 401 - Unauthorized

  • A 401 status code tells you that your request lacks proper authentication credentials or the ones you provided are not sufficient.

• 403 - Forbidden

  • If you receive a 403 status code, it's like the server saying, "You're authenticated, but sorry, you're not allowed here." This error occurs when you have insufficient permissions to access a specific resource.

• 404 - Not Found

  • When you see a 404 status code, it means the server couldn't find what you were looking for. This could be due to a mistyped URL, a resource being moved or deleted, or simply because the server doesn't recognize the endpoint you specified.

5xx status codes

5xx errors indicate issues on the server side, either due to unexpected errors or temporary unavailability. These errors require attention from server administrators to resolve underlying problems and restore proper functionality.

• 500 - Internal Server Error

  • The 500 status code indicates an unforeseen and generic error on the server side, reflecting a failure to fulfill the request due to an internal issue.

• 503 - Service Unavailable

  • A 503 status code signals that the server is temporarily unable to handle the request. This could be due to maintenance, overload, or other transient issues.

Deprecation

MetaDefender Managed File Transfer adheres to deprecation guidelines for its APIs. Developers must stay informed about the deprecation process and any modifications to the API. The deprecation period, usually spanning two releases for a given endpoint, is clearly communicated in the MetaDefender Managed File Transfer API Reference. It is crucial to exercise caution during product development to prevent complications stemming from deprecated endpoints.