APIHub
Back to Explore

Runscope API

The Runscope API provides programmatic access to a Runscope account, allowing you to list, create, retrieve, update, and delete buckets along with their tests, environments, messages, errors, and related team resources. It also exposes endpoints for test metrics, test steps, and team agents, integrations, and people.

Development
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

2538ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/account

Account Resource

GET

/buckets

Returns a list of buckets.

POST

/buckets

Create a new bucket

DELETE

/buckets/{bucketKey}

Delete a single bucket resource.

  • bucketKey (path, required) — Unique identifier for a bucket
GET

/buckets/{bucketKey}

Returns a single bucket resource.

  • bucketKey (path, required) — Unique identifier for a bucket
GET

/buckets/{bucketKey}/environments

Returns list of shared environments for a specified bucket.

  • bucketKey (path, required) — Unique identifier for a bucket
POST

/buckets/{bucketKey}/environments

Create new shared environment.

  • bucketKey (path, required) — Unique identifier for a bucket
PUT

/buckets/{bucketKey}/environments/{environmentId}

Update the details of a shared environment.

  • bucketKey (path, required) — Unique identifier for a bucket
  • environmentId (path, required) — Unique identifier for a test environment
GET

/buckets/{bucketKey}/errors

Retrieve a list of error messages in a bucket

  • bucketKey (path, required) — Unique identifier for a bucket
  • count (query, limit) — Maxiumum number of messages to return. Default 50, max 1000.
  • since (query) — Only return messages after the given Unix timestamp
  • before (query) — Only return messages before the given Unix timestamp
DELETE

/buckets/{bucketKey}/messages

Clear a bucket (remove all messages).

  • bucketKey (path, required) — Unique identifier for a bucket
GET

/buckets/{bucketKey}/messages

Retrieve a list of messages in a bucket

  • bucketKey (path, required) — Unique identifier for a bucket
  • count (query, limit) — Maxiumum number of messages to return. Default 50, max 1000.
  • since (query) — Only return messages after the given Unix timestamp
  • before (query) — Only return messages before the given Unix timestamp
POST

/buckets/{bucketKey}/messages

Create a message

  • bucketKey (path, required) — Unique identifier for a bucket
GET

/buckets/{bucketKey}/messages/{messageId}

Retrieve the details for a single message.

  • bucketKey (path, required) — Unique identifier for a bucket
  • messageId (path, required) — The unique identifier for this message
GET

/buckets/{bucketKey}/tests

Returns a list of tests.

  • bucketKey (path, required) — Unique identifier for a bucket
POST

/buckets/{bucketKey}/tests

Create a test.

  • bucketKey (path, required) — Unique identifier for a bucket
DELETE

/buckets/{bucketKey}/tests/{testId}

Delete a test, including all steps, schedules, test-specific environments and results.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
GET

/buckets/{bucketKey}/tests/{testId}

Retrieve the details of a given test by ID.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
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, and schedules subresources of the test.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
GET

/buckets/{bucketKey}/tests/{testId}/environments

Return details of the test's environments (only those that belong to the specified test)

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
POST

/buckets/{bucketKey}/tests/{testId}/environments

Create new test environment.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
PUT

/buckets/{bucketKey}/tests/{testId}/environments/{environmentId}

Update the details of a test environment.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
  • environmentId (path, required) — Unique identifier for a test environment
GET

/buckets/{bucketKey}/tests/{testId}/metrics

Return details of the test metrics for the specified timeframe.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
GET

/buckets/{bucketKey}/tests/{testId}/steps

List test steps for a test.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
POST

/buckets/{bucketKey}/tests/{testId}/steps

Add new test step.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
DELETE

/buckets/{bucketKey}/tests/{testId}/steps/{stepId}

Delete a step from a test.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
  • stepId (path, required) — Unique identifier for a test step
PUT

/buckets/{bucketKey}/tests/{testId}/steps/{stepId}

Update the details of a single test step.

  • bucketKey (path, required) — Unique identifier for a bucket
  • testId (path, required) — Unique identifier for a test
  • stepId (path, required) — Unique identifier for a test step
GET

/teams/{teamId}/agents

Team agents list

  • teamId (path, required) — Unique identifier for team
GET

/teams/{teamId}/integrations

Team integrations list

  • teamId (path, required) — Unique identifier for team
GET

/teams/{teamId}/people

Teams Resource

  • teamId (path, required) — Unique identifier for team

29 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://api.runscope.com/account"

api.runscope.com · HTTPS only