kubesphere-sigs / postman-collection

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo

ks-devops API Postman collection

Postman Collection demonstrating how to use the ks-devops REST API. More information about the API can be found on https://kubesphere.io/api/kubesphere/#tag/DevOps-Pipeline.

Installation

To use the latest published version, click the following button to import the ks-devops API as a collection:

Run in Postman

You can also download the collection file from this repo, then import directly into Postman.

Prerequisites

  • Postman The collection is for use by the Postman app. Postman is a utility that allows you to quickly test and use REST APIs. More information can be found at getpostman.com.
  • ks-devops API Token To use the API, you must have an API Token Please get a token from Kubernetes cluster .

Usage

The collection is arranged in folders according to the API endpoints.

Almost all requests require a valid ks-devops API Token. The collection requests have a placeholder variable called token for this. This should be set in your Postman environment i.e. outside the collection itself. This should help avoid accidental commits of API token to repos.

A collection-scope variable base_url points to the usual host http://localhost:9090.

ks-devops Postman environments and variables can be found here.

More information on managing Postman environments and variables can be found here.

Variable Default value Set in May override in Example
token - Environment - -
base_url http://localhost:9090 Environment Environment
devops Environment Environment
credential Environment Environment

Contribute

We welcome your contributions! See CONTRIBUTING.md for details on how to help out.

Change Log

See ChangeLog here

See Also

ks-devops API documentation

Postman API development tool

About