Runscope API API

by runscope.com

Overview

Manage Runscope programmatically.

Runscope API is a development API from runscope.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 29 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Development
Base URL: https://api.runscope.com/
Version: 1.0.0
Endpoints: 29
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.runscope.com/account" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.runscope.com/account", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.runscope.com/account",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/account`	Account Resource
GET	`/buckets`	Returns a list of buckets.
POST	`/buckets`	Create a new bucket
GET	`/buckets/{bucketKey}`	Returns a single bucket resource.
DELETE	`/buckets/{bucketKey}`	Delete a single bucket resource.
GET	`/buckets/{bucketKey}/environments`	Returns list of shared environments for a specified bucket.
POST	`/buckets/{bucketKey}/environments`	Create new shared environment.
PUT	`/buckets/{bucketKey}/environments/{environmentId}`	Update the details of a shared environment.
GET	`/buckets/{bucketKey}/errors`	Retrieve a list of error messages in a bucket
GET	`/buckets/{bucketKey}/messages`	Retrieve a list of messages in a bucket
POST	`/buckets/{bucketKey}/messages`	Create a message
DELETE	`/buckets/{bucketKey}/messages`	Clear a bucket (remove all messages).
GET	`/buckets/{bucketKey}/messages/{messageId}`	Retrieve the details for a single message.
GET	`/buckets/{bucketKey}/tests`	Returns a list of tests.
POST	`/buckets/{bucketKey}/tests`	Create a test.
GET	`/buckets/{bucketKey}/tests/{testId}`	Retrieve the details of a given test by ID.
PUT	`/buckets/{bucketKey}/tests/{testId}`	Modify a test's name, description, default environment and its steps. To modify other individual properties of a test, make requests to the steps, environments,
DELETE	`/buckets/{bucketKey}/tests/{testId}`	Delete a test, including all steps, schedules, test-specific environments and results.
GET	`/buckets/{bucketKey}/tests/{testId}/environments`	Return details of the test's environments (only those that belong to the specified test)
POST	`/buckets/{bucketKey}/tests/{testId}/environments`	Create new test environment.
PUT	`/buckets/{bucketKey}/tests/{testId}/environments/{environmentId}`	Update the details of a test environment.
GET	`/buckets/{bucketKey}/tests/{testId}/metrics`	Return details of the test metrics for the specified timeframe.
GET	`/buckets/{bucketKey}/tests/{testId}/steps`	List test steps for a test.
POST	`/buckets/{bucketKey}/tests/{testId}/steps`	Add new test step.
PUT	`/buckets/{bucketKey}/tests/{testId}/steps/{stepId}`	Update the details of a single test step.
DELETE	`/buckets/{bucketKey}/tests/{testId}/steps/{stepId}`	Delete a step from a test.
GET	`/teams/{teamId}/agents`	Team agents list
GET	`/teams/{teamId}/integrations`	Team integrations list
GET	`/teams/{teamId}/people`	Teams Resource