Get project

GET 
/project/:id

Retrieve project by ID

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

Responses

200

Successful operation

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 stringdeprecated

Project name was replaced by Project title

permissions object

Project permissions for current user

read boolean

Can current user view results?

run boolean

Can current user run checks?

editTest boolean

edit boolean

Can current user edit project settings?

manageUsers boolean

Default value: true

Can current user manage others?

apiKey boolean

Default value: true

Can current user view apiKey?

leave boolean

Default value: true

Can current user leave project?

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": "2024-03-01T17:56:20.387Z",
  "userAgent": "Testomatobot/1.0 (Linux x86_64; +https://www.testomato.com/testomatobot) minicrawler/5.2.2",
  "timeout": 3,
  "delay": 50,
  "userIds": [
    0
  ],
  "permissions": {
    "read": true,
    "run": true,
    "editTest": true,
    "edit": true,
    "manageUsers": true,
    "apiKey": true,
    "leave": true
  }
}

404

Object not found error

application/json

Schema

Schema

message string

Default value: Object not found

Error message text

code integer

Default value: 404

Error code number

ok boolean

Default value: false

error boolean

Default value: true

Example (from schema)

{
  "message": "Object not found",
  "code": 404,
  "ok": false,
  "error": true
}

Loading...