Create project

POST /project/create

Create a new project from array of URLs. Successful response will be formatted as JSONP stream. You can add up to 30 URLs at once.

Query Parameters

• period string

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

  Default value: 5 minutes

  Check period interval as string

application/json

Request Body

• urls string[]

  Array of URLs

• blank boolean

  Default value: false

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

Responses

• 200
• 400
• 403
• 406
• 500

---

There Successfully created projects. Response is JSONP payload with individual projects.

application/json

Schema

Schema

• id string

  Project ID

• title string

  Project title

• url string

  Project base URL

• period string

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

  Default value: 5 minutes

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

• uptimeUrl string

  Uptime URL

• uptimeEnabled string

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

  Uptime period in seconds - false means uptime is disabled

• apiKey string

  apiKey that can be used for the project operations

• payerId integer

  Identification of the project owner.

• location string

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

  Project check location

• checkDefaultErrors boolean

  Default value: true

• created date-time

  Date and time of project creation

• userAgent string

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

  User agent

• timeout integer

  Default value: 3

  Cumulated project timeout in seconds

• delay int64

  Default value: 50

  Bulk request delay in miliseconds

• userIds integer[]

  Array of users ID's with access to the project

• name string deprecated

  Project name was replaced by Project title

• originalUrl string

  Original URL that was processed

Example (from schema)

{
  "id": "50a9f72f14db3be812000233",
  "title": "string",
  "url": "https://testomato.com",
  "period": "5 minutes",
  "uptimeUrl": "string",
  "uptimeEnabled": false,
  "apiKey": 123456,
  "payerId": 0,
  "location": "eu",
  "checkDefaultErrors": true,
  "created": "2023-03-23T13:36:36.512Z",
  "userAgent": "Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2",
  "timeout": 3,
  "delay": 50,
  "userIds": [
    0
  ],
  "originalUrl": "string"
}

Error when trying to create more than 30 projects at once or period parameters is invalid.

application/json

Schema

Schema

• message string

  Default value: Sorry! You can only add 30 projects at a time.

• error boolean

  Default value: true

Example (from schema)

{
  "message": "Sorry! You can only add 30 projects at a time.",
  "error": true
}

Error when you have reached your subscription project limit.

application/json

Schema

Schema

• message string

  Default value: You have reached your project limit.

• error boolean

  Default value: true

Example (from schema)

{
  "message": "You have reached your project limit.",
  "error": true
}

When you try send invalid or not supported URL

application/json

Schema

Schema

• message string

  Default value: Oops, we're sorry! The URL "xxx" is not valid

• error boolean

  Default value: true

Example (from schema)

{
  "message": "Oops, we're sorry! The URL \"xxx\" is not valid",
  "error": true
}

Project creation failed with fatal error (please contact us at support@testomato.com).

application/json

Schema

Schema

• message string

  Default value: Oops, we're sorry! Project creation failed. Please try later or contact us.

• error boolean

  Default value: true

Example (from schema)

{
  "message": "Oops, we're sorry! Project creation failed. Please try later or contact us.",
  "error": true
}

Loading...