Skip to main content

New project

POST 
/project/create

Create a new project from given URL. Response will be a new project object or error message.

Request​

Body

    urlstringrequired

    URL to be checked

    Example: https://www.example.com
    addPresetChecksboolean

    Create empty project (true) or preset project (false)

    Default value: false
    checkIntervalstring
    • not set - default value by subscription plan
    • 5 minutes - every 5 minutes
    • 30 minutes - every 30 minutes
    • 1 hour - every hour
    • 8 hours - every 8 hours
    • 1 day - every day
    • 7 days - every week
    • false - run manually, no schedule

    Possible values: [5 minutes, 30 minutes, 1 hour, 8 hours, 1 day, 7 days, false]

    urlsstring[]deprecated

    Deprecated, use url instead

    blankbooleandeprecated

    Deprecated, use addPresetChecks instead

    Default value: false

Responses​

Project was successfully created.

Schema

    idstring

    Project ID

    Example: 50a9f72f14db3be812000233
    titlestring

    Project title

    urlstring

    Project base URL

    Example: https://testomato.com
    periodstring

    Period of test checking - false means never check Test automatically.

    Possible values: [5 minutes, 30 minutes, 1 hour, 8 hours, 1 day, 7 days, false]

    Default value: 5 minutes
    uptimeUrlstring

    Uptime URL

    uptimeEnabledstring

    Uptime period in seconds - false means uptime is disabled

    Possible values: [false, 15, 30, 60]

    apiKeystring

    apiKey that can be used for the project operations

    Example: 123456
    payerIdinteger

    Identification of the project owner.

    locationstring

    Project check location

    Possible values: [eu, de, gb, ca, us, tx, dc, sg, hk]

    checkDefaultErrorsboolean
    Default value: true
    createddate-time

    Date and time of project creation

    userAgentstring

    User agent

    Default value: Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2
    timeoutinteger

    Cumulated project timeout in seconds

    Default value: 3
    delayint64

    Bulk request delay in miliseconds

    Default value: 50
    userIdsinteger[]

    Array of users ID's with access to the project

    namestringdeprecated

    Project name was replaced by Project title

Last updated on