Skip to main content

OpenAPI, Swagger & Postman

Skywalk API ships machine-readable API definitions so you can explore endpoints interactively, generate client SDKs, and import the full collection into your favorite HTTP tool.

Interactive Swagger UI​

Browse every endpoint, see request and response schemas, and try live requests from your browser using Swagger UI.

Open Swagger UI →

Click Authorize in the Swagger UI and paste your API key to send authenticated requests. Requests made against production endpoints count toward your account's usage.

OpenAPI 3 Specification​

The full OpenAPI 3 spec for every Skywalk API endpoint is served as JSON:

https://api.skywalkapi.com/openapi.json

Use it to:

  • Generate type-safe clients in any language with tools like openapi-generator or openapi-typescript
  • Validate requests and responses against the schema
  • Import into API tools like Insomnia, Bruno, or Paw
  • Feed into AI coding agents that understand OpenAPI

The spec is grouped by marketplace package so related endpoints stay together, and it updates automatically as new endpoints are released.

Postman Collection​

Import the Skywalk API Postman collection to try requests and share them with your team:

https://api.skywalkapi.com/postman-collection.json

Importing into Postman​

  1. Open Postman and click Import
  2. Choose Link and paste the URL above
  3. Click Continue, then Import

Once imported, open the collection's Variables tab and set apiKey to your Skywalk API key. All requests share the same baseUrl and apiKey variables, so you only need to set them once.

The collection includes every GET and POST endpoint with:

  • Pre-filled headers (X-API-Key, Content-Type)
  • Documented query parameters with descriptions and defaults
  • Example request bodies for POST endpoints
  • Endpoints grouped into folders by marketplace package