FTP Profiles
Overview
The FTP Profiles endpoint allows you to manage your FTP Profiles, by creating new FTP Profiles, or by requesting information about or updating existing FTP Profiles.
Endpoint (North America): https://api.eccmp.com/services2/api/FtpProfile
Endpoint (Europe): https://api.ccmp.eu/services2/api/FtpProfile
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/FtpProfile
For more details on how to set up an FTP Profile API request, please see the FTP Profile / FTP Import Template API Technical Guide.
GET Method
The FTP Profiles endpoint supports the following GET operations.
Retrieve all FTP Profiles
This endpoint allows you to retrieve information about all the FTP Profiles in your account.
Click hereClick here to see a sample response message in JSON format.
[
{
"profile_id": 123,
"profile_name": "sftp://sftp.cheetahdigital.com - johnsmith",
"user_name": "johnsmith",
"password": "Nc0@C@ss!@",
"domain_name": "sftp://sftp.cheetahdigital.com",
"passive_mode_flag": 0
},
{
"profile_id": 456,
"profile_name": "sftp://ftp.eccmp.com - adminuser",
"user_name": "adminuser",
"password": "automation123",
"domain_name": "sftp://ftp.eccmp.com",
"passive_mode_flag": 0
},
]
Retrieve an FTP Profile
This endpoint allows you to retrieve information about a specified FTP Profile by providing its Object Reference ID.
Click hereClick here to see a sample response message in JSON format.
[
{
"profile_id": 123,
"profile_name": "sftp://sftp.cheetahdigital.com - johnsmith",
"user_name": "johnsmith",
"password": "Nc0@C@ss!@",
"domain_name": "sftp://sftp.cheetahdigital.com",
"passive_mode_flag": 0
},
]
POST Method
The FTP Profiles endpoint supports the following POST operation. This endpoint allows you to create a new FTP Profile by providing the following basic information:
The FTP Profile name
The username / password for this FTP Profile
The domain URL for this FTP Profile; this URL must begin with the prefix "sftp://".
Click hereClick here to see a sample request message in JSON format.
{
"profile_name": "API FTP Profile",
"user_name": "Cheetah Admin",
"password": "password123",
"domain_name": "sftp://10.24.88.92",
"passive_mode_flag": 0,
"password_confirm": "password123"
}
Click hereClick here to see a sample response message in JSON format.
{
"profile_id": 34,
"profile_name": "API FTP Profile",
"user_name": "Cheetah Admin",
"password": "password123",
"domain_name": "sftp://10.24.88.92",
"passive_mode_flag": 0,
"password_confirm": "password123"
}
PUT Method
The FTP Profile endpoint supports the following PUT operation. This endpoint allows you to submit modifications to an existing FTP Profile. The request message must include the FTP Profile's Object Reference ID and the desired changes.
Click hereClick here to see a sample response message in JSON format.
{
"profile_id": 33,
"profile_name": "API FTP Profile",
"user_name": "newusername",
"password": "password123",
"domain_name": "sftp://sftp.cheetahdigital.com",
"passive_mode_flag": 0,
"password_confirm": "password123"
}
DELETE Method
The FTP Profile endpoint supports a DELETE operation that will delete the specified FTP Profile. You must provide the Object Reference ID for the desired FTP Profile.
Back to API Category - Data Management