Stoplight

Stoplight

Stoplight endpoints from Stoplight

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

Stoplight endpoints from Stoplight

Endpoints 5

Versions

  • GETExport/versions/:versionId/export/:formatExport a version to your choice of API specification. Allowed Formats: oas.json oas.yaml raml08.yaml raml10.yaml stoplight.json stoplight.yaml The stoplight…
  • PUTImport/versions/:versionId/importImport the given specification into an existing version. Warning, this is a destructive action! Any resources present in both the existing version, and the…
  • POSTPublish/versions/:versionId/publishRe-publish an API version in Stoplight. This will re-publish the given API version, with whatever publish settings have already been setup in the app. This…
  • PUTUnpublish/versions/:versionId/unpublishUnpublish the documentation associated with the given API version.
  • POSTPublish Anonymous/versions/publish/anonAnonymously publish to API Docs. This endpoint will take a JSON spec or a URL to a swagger or raml spec. { "specData": {...} } or { "url":…

API details

Base URL
https://api.stoplight.io/v1
Authentication
An API key in the Authorization header
Operations
5 operations on 5 pathsPUT 2POST 2GET 1
Main resources
Versions 4
Response formats
application/json text/yaml
Description format
OpenAPI 3.0.0, API version api-v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Stoplight 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 Stoplight collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Export” (GET /versions/:versionId/export/:format), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Stoplight?

Stoplight endpoints from Stoplight It is listed under Developer tools and has 5 endpoints.

Who publishes the Stoplight?

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

What is the base URL of the Stoplight?

Requests go to https://api.stoplight.io/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Stoplight?

With an API key in the Authorization header.

How many endpoints does the Stoplight have?

5 operations on 5 paths (2 PUT, 2 POST, 1 GET). The largest groups are Versions.

Is forking the Stoplight 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.