Endpoint
/api/v2/tenants/{tenantId}/resources
Path Parameters
tenantId
string

Describes the client ID of the tenant

checkType
string

Specifies the category type. Example: http, https, ftp, and so on.

credential
object

Specifies the credentials. Examples: - securityLevel: basic - userName - password

credential.oauthAccessTokenUrl
credential.oauthClientKey
credential.oauthClientSecret
credential.oauthGrantType
credential.password
credential.securityLevel
credential.userName
downloadFilePath
string

(Optional) Specifies the path where you want to download the file.

extResourceId
string

External Id of the resource.

hostName
string

locationUuids
array

Array of UUIDs of locations you want to bind.

metaData
object

Metadata for the resource.

name
string

Name of resource.

resourceName
string

resourceType
string

Type of resource. Use SYNTHETIC for synthetic.

script
string

Use this text only if the checkType is set to SCRIPT: - For Python script: seleniumPython - ScriptFor JSON script obtained from Selenium IDE: seleniumJsonScript

sslCertKeyPath
string

(Optional) Path of the SSL certificate key.

sslCertPath
string

(Optional) Path of the SSL certificate.

uploadStream
string

url
string

URL of the synthetic.

{
  "checkType": "DNS",
  "host": "www.indians.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Indian Army",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "string",
  "extResourceId": "string",
  "hostName": "string",
  "locationUuids": [
    "string"
  ],
  "metaData": {},
  "name": "string",
  "resourceName": "string",
  "resourceType": "string",
  "sslCertKeyPath": "string",
  "url": "string"
}
{
  "extResourceId": "extResourceId_123",
  "hostName": "testdevice-api",
  "metaData": {
    "property1": "value1",
    "property2": "value2",
    "property3": "value3"
  },
  "name": "testresource-api",
  "resourceType": "Device"
}
{
  "checkType": "HTTP",
  "credential": {
    "password": "s1234",
    "securityLevel": "basic",
    "userName": "s1234"
  },
  "locationUuids": [
    "7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca"
  ],
  "resourceName": "Indian",
  "resourceType": "SYNTHETIC",
  "url": "www.oriental.com"
}
{
  "checkType": "HTTP",
  "credential": {
    "password": "s1234",
    "securityLevel": "ntlm",
    "userName": "s1234"
  },
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Indian",
  "resourceType": "SYNTHETIC",
  "url": "www.oriental.com"
}
{
  "checkType": "HTTP",
  "credential": {
    "oauthAccessTokenUrl": "auth/oauth/token",
    "oauthClientKey": "kHSageRP9CTeCFP7Wfrzzc45pFJZ99N4",
    "oauthClientSecret": "5w6rKEAgYpsYDdd8vm5PnUMsQWqTnh423FArQYxGW6V3zqDcTG2z7UvjV3YBMq9Y",
    "oauthGrantType": "client_credentials",
    "securityLevel": "oauth2"
  },
  "locationUuids": [
    "7b77f37f-5eb0-4ec2-bd19-15cc6853e3ca"
  ],
  "resourceName": "Indian",
  "resourceType": "SYNTHETIC",
  "url": "www.oriental.com"
}
{
  "checkType": "HTTPS",
  "credential": {
    "password": "s1234",
    "securityLevel": "basic",
    "userName": "s1234"
  },
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "International",
  "resourceType": "SYNTHETIC",
  "sslCertKeyPath": "",
  "sslCertPath": "",
  "url": "www.international.com"
}
{
  "checkType": "HTTPS",
  "credential": {
    "password": "s1234",
    "securityLevel": "ntlm",
    "userName": "s1234"
  },
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "International",
  "resourceType": "SYNTHETIC",
  "sslCertKeyPath": "",
  "sslCertPath": "",
  "url": "www.international.com"
}
{
  "checkType": "HTTPS",
  "credential": {
    "password": "s1234",
    "securityLevel": "oauth2",
    "userName": "s1234"
  },
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "International",
  "resourceType": "SYNTHETIC",
  "sslCertKeyPath": "",
  "sslCertPath": "",
  "url": "www.international.com"
}
{
  "checkType": "IMAP",
  "credential": {
    "password": "s1234",
    "securityLevel": "basic",
    "userName": "s1234"
  },
  "host": "www.angrymen.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "AngryMen",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "PING",
  "host": "www.wearehumans.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Human Beings",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "POP3",
  "credential": {
    "password": "s1234",
    "securityLevel": "basic",
    "userName": "s1234"
  },
  "host": "www.blooddiamond.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "BloodDiamond",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "SCRIPT",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "This is Script2",
  "resourceType": "SYNTHETIC",
  "script": "Yourscript"
}
{
  "checkType": "SMTP",
  "credential": {
    "password": "s1234",
    "securityLevel": "basic",
    "userName": "s1234"
  },
  "host": "www.romanholiday.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Roman Holiday",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "SSL",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Tom Hanks",
  "resourceType": "SYNTHETIC",
  "url": "www.tomhanks.com"
}
{
  "checkType": "TCP",
  "host": "www.wearenobody.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "NoBody",
  "resourceType": "SYNTHETIC"
}
{
  "checkType": "UDP",
  "host": "www.wearenothing.com",
  "locationUuids": [
    "223087d3-ef45-4efd-9587-0b20ad8ca355",
    "ac346708-cb6a-4221-adc2-6b15c0d6e5af"
  ],
  "resourceName": "Nothing",
  "resourceType": "SYNTHETIC"
}

Responses

OK

resourceUUID
string

tenantID
string

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