Resources for FTP

This endpoint is used to create synthetic resources for FTP.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/resources

Sample URLs

https://{api-url}/api/v2/tenants/<clientId>/resources

Parameters

FieldData TypeDescription
hostName/resourceNameStringName of the host.
resourceTypeStringType of resource. Use SYNTHETIC for synthetic.
checkTypeStringSpecifies the category type.
Example: http, https, ftp, and so on.
urlStringURL of the synthetic.
locationUuidsStringArray of UUIDs of locations you want to bind.
credential
  • securityLevel
  • userName
  • password
StringSpecifies the credentials. Examples:
  • securityLevel: basic
  • userName
  • password
uploadStreamString(Optional)
downloadFilePathString(Optional) Specifies the path where you want to download the file.

Sample request

{
 "resourceType":"SYNTHETIC",
  "checkType" : "FTP",
  "resourceName" : "The Good Lie",
  "host" : "www.thegoodlie.com",
  "uploadStream" : " ",
  "downloadFilePath" : " ",
  "credential" :{
    "securityLevel" : "basic",
    "userName" : "s1234",
    "password" : "s1234"
   },
  "locationUuids" :
   [ "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"]
}

Sample response

{
	"resourceUUID": "612acfb0-6890-4d52-950b-1c4ec17a7248",
	"tenantID": "client_5"
}