Testkube Control Plane ../status-pages operations
Testkube Pro API (cloud-api/1.10.51)
Download OpenAPI specification:Download
API for Testkube Pro
List status pages
Returns a list of status pages
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
Responses
Response samples
- 200
- 400
- 500
{- "elements": [
- {
- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
]
}
Create new status page
Creates a new status page
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
Request Body schema: application/json
body passed to configure new status page
id | string |
name | string |
description | string A short description to clarify the purpose of this page |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
organizationId | string Organization ID |
environmentId | string Environment ID |
timeScale | string The periodicity for the aggregated status checks |
Array of objects (StatusService) List of services tests are grouped by | |
isPublic | boolean Flag that marks the accessibility of the page. Public pages are published to the internet |
slug | string Globally unique chosen identifier for the status page used in the public URL |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
Get status page by ID
Returns a status page for the given statusPageId
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
Delete a status page
Deletes the status page with the given ID
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string |
Responses
Response samples
- 404
- 500
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Update an existing status page
Updates an existing status page
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string |
Request Body schema: application/json
body passed to configure new status page
id | string |
name | string |
description | string A short description to clarify the purpose of this page |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
organizationId | string Organization ID |
environmentId | string Environment ID |
timeScale | string The periodicity for the aggregated status checks |
Array of objects (StatusService) List of services tests are grouped by | |
isPublic | boolean Flag that marks the accessibility of the page. Public pages are published to the internet |
slug | string Globally unique chosen identifier for the status page used in the public URL |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
Response samples
- 200
- 400
- 404
- 500
{- "id": "string",
- "name": "string",
- "description": "This page shows the status of the tests running on the production environment of MyService",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "organizationId": "string",
- "environmentId": "string",
- "timeScale": "1d1h1m1s",
- "services": [
- {
- "name": "API Services",
- "contents": [
- {
- "name": "Backend API",
- "type": "test",
- "status": "unknown"
}
], - "operability": 99.999,
- "status": "unknown",
- "timeline": [
- {
- "startTime": "string",
- "endTime": "string",
- "status": "unknown",
- "observables": {
- "test-1": "operational",
- "test-2": "major_outage"
}
}
]
}
], - "isPublic": true,
- "slug": "mySlugName"
}
List incidents for a status page
Returns the list of incidents assigned to a status page
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string unique id of the status page |
query Parameters
visibility | string Enum: "draft" "published" "archived" specifies how public the incident is |
Responses
Response samples
- 200
- 400
- 500
{- "elements": [
- {
- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
]
}
Create new incident
Creates an incident
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string unique id of the status page |
Request Body schema: application/json
body passed to configure new incident
id | string |
name required | string Name of the incident |
description required | string incident details in markdown |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
severity required | string Enum: "critical" "major" "minor" "low" "info" the severity of the outage caused by the incident |
visibility required | string Enum: "draft" "published" "archived" specifies how public the incident is |
startDate | string or null <date-time> start of the incident |
endDate | string or null <date-time> end of the incident |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
Response samples
- 201
- 400
- 500
{- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
Get incident by ID
Returns an incident for the given incidentID
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string unique id of the status page |
incidentID required | string |
Responses
Response samples
- 200
- 404
- 500
{- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
Deletes an incident
Deletes the incident with the given ID
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string unique id of the status page |
incidentID required | string |
Responses
Response samples
- 404
- 500
{- "title": "Invalid test name",
- "status": 500,
- "detail": "Your test name can't contain forbidden characters like \"}}}\" passed",
}
Updates an existing incident
Updates an existing incident
path Parameters
id required | string unique id of the object |
environmentID required | string unique id of the environment |
statusPageID required | string unique id of the status page |
incidentID required | string |
Request Body schema: application/json
body passed to configure new incident
id | string |
name required | string Name of the incident |
description required | string incident details in markdown |
object | |
createdAt | string <date-time> |
updatedAt | string <date-time> |
severity required | string Enum: "critical" "major" "minor" "low" "info" the severity of the outage caused by the incident |
visibility required | string Enum: "draft" "published" "archived" specifies how public the incident is |
startDate | string or null <date-time> start of the incident |
endDate | string or null <date-time> end of the incident |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}
Response samples
- 200
- 400
- 404
- 500
{- "id": "string",
- "name": "API migration problem",
- "description": "API Service was down due to unexpected changes in one of the dependencies.",
- "labels": {
- "property1": "string",
- "property2": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "severity": "critical",
- "visibility": "draft",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z"
}