CLI, REST API, and CI/CD plugins — everything you need to deploy, validate, and manage APIs automatically.
$ apiportal deploy --env production
✓ Uploading OpenAPI spec... done
✓ Validating schema... passed (0 errors)
✓ Generating documentation... done
✓ Running linter checks... passed
✓ Publishing to portal... done
✓ Deployed successfully!
→ https://app.api-portal.io/docs/payment-api/v3
$
Your toolkit at a glance
// CLI
// CLI Tool
The API Portal CLI is your central tool for managing APIs directly from the terminal. Login, upload, validation, and environment management — all in one command.
$ apiportal login
✓ Authenticated as jan@netscale.io
$ apiportal push --file openapi.yaml
✓ Uploading openapi.yaml... done
✓ Version v2.4.0 created
$ apiportal validate openapi.yaml
✓ Schema valid (0 errors, 0 warnings)
$ apiportal environments list
production ● active v2.4.0
staging ● active v2.5.0-beta
development ● idle v2.5.0-dev
$
// REST API
GET /api/management/v1/capabilities
Authorization: Bearer eyJhbGci...kpXVCJ9
X-Tenant-ID: tenant-netscale-prod
// Response 200 OK
{
"data": [
{
"id": "cap_payment_api",
"name": "Payment API",
"version": "3.1.0",
"status": "published"
}
],
"cursor": "eyJpZCI6MTB9"
}
// REST API
The full management API is built on OpenAPI 3.1.0 and gives you programmatic access to every API Portal feature.
// CI/CD
Integrate API Portal seamlessly into your existing pipeline — with native plugins for the most popular platforms.
# .github/workflows/deploy.yml
name: Deploy API Spec
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: apiportal/deploy@v1
with:
file: openapi.yaml
env: production
# .gitlab-ci.yml
stages:
- deploy
deploy_api:
stage: deploy
image: apiportal/cli:latest
script:
- apiportal login --token $PAT
- apiportal push --file openapi.yaml
- apiportal deploy --env production
only:
- main
// Jenkinsfile
pipeline {
agent any
stages {
stage('Deploy API') {
steps {
sh '''
apiportal login \
--token $PAT
apiportal deploy \
--file openapi.yaml \
--env production
'''
}
}
}
}
// Authentication
// PAT
Personal Access Tokens provide secure, granular authentication for CLI and API. Manage permissions, set expiration dates, and revoke tokens at any time.
| Name | Scopes | Ablaufdatum | |
|---|---|---|---|
| CI/CD Pipeline | read write | 2026-06-15 | Widerrufen |
| Local Dev | read | 2026-04-01 | Widerrufen |
| Admin Tools | read write admin | 2026-12-31 | Widerrufen |
“Since we started using API Portal's CI/CD integration, our manual deployments dropped by 90%. The CLI is intuitive and the REST API covers everything we need.”
// More features
Get started with CLI, REST API, and CI/CD integration — and take your API workflows to the next level.