Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Express Gateway Scopes API

The Scopes API from Express Gateway — 2 operation(s) for scopes.

Express Gateway Scopes API is one of 5 APIs that Express Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scopes. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, http://localhost:9876.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
http://localhost:9876
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Express Gateway Scopes API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (KeyAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • KeyAuth — When the Admin API is fronted by Express Gateway with key-auth, send "Authorization: apikey {keyId}:{keySecret}".

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Scopes 5
GET
/scopes
List scopes
listScopes → 200
POST
/scopes
Create scopes
createScopes body → 201
GET
/scopes/{scope}
Check whether a scope exists
getScope 1 param → 200404
PUT
/scopes/{scope}
Create a single scope
createScope 1 param → 201
DELETE
/scopes/{scope}
Delete a scope
deleteScope 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

express-gateway-scopes-api-openapi.yml Raw ↑

Other APIs Express Gateway publishes across the network.

Express Gateway
Express Gateway Apps API
Express Gateway Credentials API
Express Gateway Users API