Runscope

Runscope API

Manage Runscope programmatically.

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Manage Runscope programmatically.

Endpoints 29

Account

  • GETAccount Resource/accountInformation about the authorized account.
  • GETTeam agents list/teams/:teamId/agentsList currently connected agents associated with a given team.
  • GETTeam integrations list/teams/:teamId/integrationsReturns a list of integrations configured for the team.
  • GETTeams Resource/teams/:teamId/peopleList people and integrations associated with a given team.

Buckets

  • GETReturns a list of buckets./buckets
  • POSTCreate a new bucket/buckets
  • GETReturns a single bucket resource./buckets/:bucketKey
  • DELETEDelete a single bucket resource./buckets/:bucketKey

Shared Environments

  • GETReturns list of shared environments for a specified bucket./buckets/:bucketKey/environments
  • POSTCreate new shared environment./buckets/:bucketKey/environments
  • PUTUpdate the details of a shared environment./buckets/:bucketKey/environments/:environmentId

Messages

  • GETRetrieve a list of error messages in a bucket/buckets/:bucketKey/errors?count=0&since=0&before=0
  • GETRetrieve a list of messages in a bucket/buckets/:bucketKey/messages?count=0&since=0&before=0
  • POSTCreate a message/buckets/:bucketKey/messages
  • DELETEClear a bucket (remove all messages)./buckets/:bucketKey/messages
  • GETRetrieve the details for a single message./buckets/:bucketKey/messages/:messageId

Tests

  • GETReturns a list of tests./buckets/:bucketKey/tests
  • POSTCreate a test./buckets/:bucketKey/tests
  • GETRetrieve the details of a given test by ID./buckets/:bucketKey/tests/:testId
  • PUTModify 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./buckets/:bucketKey/tests/:testId
  • DELETEDelete a test, including all steps, schedules, test-specific environments and results./buckets/:bucketKey/tests/:testId
  • GETReturn details of the test metrics for the specified timeframe./buckets/:bucketKey/tests/:testId/metrics

Test Environments

  • GETReturn details of the test's environments (only those that belong to the specified test)/buckets/:bucketKey/tests/:testId/environments
  • POSTCreate new test environment./buckets/:bucketKey/tests/:testId/environments
  • PUTUpdate the details of a test environment./buckets/:bucketKey/tests/:testId/environments/:environmentId

Test Steps

  • GETList test steps for a test./buckets/:bucketKey/tests/:testId/steps
  • POSTAdd new test step./buckets/:bucketKey/tests/:testId/steps
  • PUTUpdate the details of a single test step./buckets/:bucketKey/tests/:testId/steps/:stepId
  • DELETEDelete a step from a test./buckets/:bucketKey/tests/:testId/steps/:stepId

API details

Base URL
https://api.runscope.com
Authentication
OAuth 2.0 (authorization code flow) with 8 scopes
Operations
29 operations on 18 pathsGET 15POST 6PUT 4DELETE 4
Main resources
Tests 6Messages 5Account 4Buckets 4Test Steps 4Shared Environments 3Test Environments 3
Response formats
application/json
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Runscope API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Runscope API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 8 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Account Resource” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Runscope API?

Manage Runscope programmatically. It is listed under Developer tools and has 29 endpoints.

Who publishes the Runscope API?

It is listed from Runscope's public API description (an OpenAPI document), not published by Runscope on Swastik Codes. Anyone who controls runscope.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Runscope API?

Requests go to https://api.runscope.com. Endpoint paths are added to this base URL.

How do I authenticate with the Runscope API?

With OAuth 2.0 (authorization code flow) with 8 scopes.

How many endpoints does the Runscope API have?

29 operations on 18 paths (15 GET, 6 POST, 4 PUT, 4 DELETE). The largest groups are Tests, Messages, Account, Buckets.

Is forking the Runscope API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.