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

WSO2 APIKeys API

The APIKeys API from WSO2 — 16 operation(s) for apikeys.

WSO2 APIKeys API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include APIKeys. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 16 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

16 operations 16 paths 23 schemas 5 GET11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 APIKeys API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 16

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

APIKeys 16
GET
/api-keys
Get all API Keys
getAllAPIKeys → 200400404412
POST
/api-keys/revoke
Revoke an API Key
revokeAPIKeyFromAdmin body → 200400412
POST
/apis/{apiId}/api-keys/generate
Generate API Key
generateApiBoundApiKey 2 params body → 200400404412
POST
/apis/{apiId}/api-keys/regenerate
Regenerate API Key
regenerateAPIBoundAPIKey 2 params body → 200400404412
GET
/apis/{apiId}/api-keys
Get API Key(s) of a Given API
getAPIBoundAPIKeys 2 params → 200400404412
POST
/apis/{apiId}/api-keys/revoke
Revoke API Key
revokeAPIBoundAPIKey 2 params body → 200400404412
POST
/apis/{apiId}/api-keys/associate
Create an association for the API Key
associateAPIKey 2 params body → 200400404412
POST
/apis/{apiId}/api-keys/dissociate
Remove an Association for the API Key
dissociateAPIKey 2 params body → 200400404412
POST
/applications/{applicationId}/api-keys/{keyType}/generate
Generate API Key
applicationsApplicationIdApiKeysKeyTypeGeneratePost 3 params body → 200400404412
POST
/applications/{applicationId}/api-keys/{keyType}/regenerate
Regenerate API Key
regenerateAppBoundAPIKey 3 params body → 200400404412
GET
/applications/{applicationId}/api-keys/{keyType}
Get API Key(s) of a Given Type
getAppBoundAPIKeys 3 params → 200400404412
POST
/applications/{applicationId}/api-keys/{keyType}/revoke
Revoke API Key
applicationsApplicationIdApiKeysKeyTypeRevokePost 3 params body → 200400412
GET
/applications/{applicationId}/api-keys/{keyType}/subscriptions
Get Subscribed APIs with API Key(s) of a Given Type
getSubscribedAPIsWithAPIKeys 3 params → 200400404412
POST
/applications/{applicationId}/api-keys/{keyType}/associate
Associate an API Key to the Application
associateAPIKeyToApp 3 params body → 200400404412
POST
/applications/{applicationId}/api-keys/{keyType}/dissociate
Remove the association of the API Key to the Application
dissociateAPIKeyFromApp 3 params body → 200400404412
GET
/applications/{applicationId}/api-keys/{keyType}/associations
Get API Key associations of a Given Type
getAPIKeyAssociationsForApp 3 params → 200400404412

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are APIKey (9 properties), APIKeyAssociationInfo (7 properties), APIAPIKeyInfo (6 properties), Error (5 properties). Each schema is shown below with its type and property counts.

SubscribedAPIWithApiKeyList
object
2 properties
APIKeyAssociationList
object
2 properties
ErrorListItem
object
2 properties 2 required
APIKeyRenewRequest
object
1 property 1 required
Error
object
5 properties 2 required
APIKeyInfo
object
5 properties
APIAPIKeyGenerateRequest
object
4 properties
APIKeyAssociation
object
3 properties
APIKeyList
object
2 properties
APIAPIKeyInfo
object
6 properties
APIKeyGenerateRequest
object
3 properties
APIKey_2
object
3 properties
APIAPIKeyList
object
2 properties
APIKeyRevokeRequest
object
1 property 1 required
APIWithKeyInfo
object
4 properties
APIAPIKeyRevokeRequest
object
1 property 1 required
APIKeyRevokeRequest_2
object
2 properties
AppAPIKeyAssociateRequest
object
2 properties 2 required
APIKeyList_2
object
2 properties
APIAPIKeyAssociateRequest
object
2 properties 2 required
APIKeyDissociateRequest
object
1 property 1 required
APIKey
object
9 properties
APIKeyAssociationInfo
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-apikeys-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Documents API