New project
POST/project/create
Create a new project from given URL. Response will be a new project object or error message.
Request
- application/json
Body
not set
- default value by subscription plan5 minutes
- every 5 minutes30 minutes
- every 30 minutes1 hour
- every hour8 hours
- every 8 hours1 day
- every day7 days
- every weekfalse
- run manually, no schedule
URL to be checked
https://www.example.com
Create empty project (true
) or preset project (false
)
false
Possible values: [5 minutes
, 30 minutes
, 1 hour
, 8 hours
, 1 day
, 7 days
, false
]
Deprecated, use url
instead
Deprecated, use addPresetChecks
instead
false
Responses
- 200
- 400
- 402
- 410
- 432
- 433
- 434
- 500
Project was successfully created.
- application/json
- Schema
- Example (from schema)
Schema
Project ID
50a9f72f14db3be812000233
Project title
Project base URL
https://testomato.com
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
]
5 minutes
Uptime URL
Uptime period in seconds - false
means uptime is disabled
Possible values: [false
, 15
, 30
, 60
]
apiKey that can be used for the project operations
123456
Identification of the project owner.
Project check location
Possible values: [eu
, de
, gb
, ca
, us
, tx
, dc
, sg
, hk
]
true
Date and time of project creation
User agent
Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2
Cumulated project timeout in seconds
3
Bulk request delay in miliseconds
50
Array of users ID's with access to the project
Project name was replaced by Project title
{
"id": "50a9f72f14db3be812000233",
"title": "string",
"url": "https://testomato.com",
"period": "5 minutes",
"uptimeUrl": "string",
"uptimeEnabled": false,
"apiKey": 123456,
"payerId": 0,
"location": "eu",
"checkDefaultErrors": true,
"created": "2024-08-19T13:18:07.483Z",
"userAgent": "Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2",
"timeout": 3,
"delay": 50,
"userIds": [
0
]
}
Project creation failed with validation error.
- application/json
- Schema
- Example (from schema)
Schema
Oops, we're sorry! Project creation failed. Please try later or contact us.
{
"message": "Oops, we're sorry! Project creation failed. Please try later or contact us."
}
You have reached the project limit of your subscription limit. Please upgrade your subscription before adding more projects.
- application/json
- Schema
- Example (from schema)
Schema
You have reached the project limit of your subscription limit. Please upgrade your subscription before adding more projects.
{
"message": "You have reached the project limit of your subscription limit. Please upgrade your subscription before adding more projects."
}
We're sorry! The URL https://url seems to be invalid.
- application/json
- Schema
- Example (from schema)
Schema
We're sorry! The URL https://url seems to be invalid.
{
"message": "We're sorry! The URL https://url seems to be invalid."
}
Deprecated parameter "urls", please use "url" instead.
- application/json
- Schema
- Example (from schema)
Schema
Deprecated parameter "urls", please use "url" instead.
{
"message": "Deprecated parameter \"urls\", please use \"url\" instead."
}
Deprecated parameter "blank", please use "addPresetChecks" instead.
- application/json
- Schema
- Example (from schema)
Schema
Deprecated parameter "blank", please use "addPresetChecks" instead.
{
"message": "Deprecated parameter \"blank\", please use \"addPresetChecks\" instead."
}
Missing mandatory parameter "url"
- application/json
- Schema
- Example (from schema)
Schema
Missing mandatory parameter "url"
{
"message": "Missing mandatory parameter \"url\""
}
Project creation failed with fatal error (please contact us at support@testomato.com).
- application/json
- Schema
- Example (from schema)
Schema
Oops, we're sorry! Project creation failed. Please try later or contact us.
{
"message": "Oops, we're sorry! Project creation failed. Please try later or contact us."
}